Deployments.ai Docs
System

End every session, refresh token, and device grant without disabling the person

POST /v1/system/principals/{principalId}/sessions/revoke · SDK revokeSystemPrincipalSessions · CLI deployments system people revoke-sessions

POST
/v1/system/principals/{principalId}/sessions/revoke

Requires platform:admin.

Authorization

tenantJwt
headerAuthorizationBearer <token>

Tenant JWT carrying organization, project, and environment claims.

Path Parameters

principalId*string

The person's principal ID.

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

Request Body

application/json
  1. body
reason*string

Why the operator acts; recorded in the person's security events.

Lengthlength <= 500

Response Body

SystemPrincipalSessionsRevokedResponse

application/json
  1. response
principalId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
sessionsEndedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
curl -X POST "https://example.com/v1/system/principals/string/sessions/revoke" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{  "principalId": "string",  "sessionsEndedAt": "2019-08-24T14:15:22Z"}