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
Requires platform:admin.
tenantJwtheader
AuthorizationBearer <token>Tenant JWT carrying organization, project, and environment claims.
principalId*stringThe person whose status to change.
Match
^[0-7][0-9A-HJKMNP-TV-Z]{25}$application/json- body
reason*stringWhy the status changes; recorded in the person's security events.
Length
length <= 500status*stringdisabled refuses the person's credentials and ends their sessions; active restores sign-in.
Value in
"active""disabled"SystemPrincipalStatusResponse
application/json- response
changed*booleanfalse when the person already had the requested status, so nothing was written.
principalId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$status*stringdisabled refuses the person's credentials and ends their sessions; active restores sign-in.
Value in
"active""disabled"updatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecurl -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"}