Deployments.ai Docs
System

Disable a person, which ends their sessions, or re-enable them

PUT /v1/system/principals/{principalId}/status · SDK replaceSystemPrincipalStatus · CLI deployments system set-principal-status

PUT
/v1/system/principals/{principalId}/status

Requires platform:admin.

Authorization

tenantJwt
headerAuthorizationBearer <token>

Tenant JWT carrying organization, project, and environment claims.

Path Parameters

principalId*string

The person whose status to change.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Request Body

application/json
  1. body
reason*string

Why the status changes; recorded in the person's security events.

Lengthlength <= 500
status*string

disabled refuses the person's credentials and ends their sessions; active restores sign-in.

Value in"active""disabled"

Response Body

SystemPrincipalStatusResponse

application/json
  1. response
changed*boolean

false when the person already had the requested status, so nothing was written.

principalId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
status*string

disabled refuses the person's credentials and ends their sessions; active restores sign-in.

Value in"active""disabled"
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
curl -X PUT "https://example.com/v1/system/principals/string/status" \  -H "Content-Type: application/json" \  -d '{    "reason": "string",    "status": "active"  }'
{  "changed": true,  "principalId": "string",  "status": "active",  "updatedAt": "2019-08-24T14:15:22Z"}