1. Docs
  2. API Reference
  3. Revoke all active sessions for an identity

Revoke all active sessions for an identity

POST/portal/v1/accounts/{accountSlug}/identities/{id}/revoke-sessions

Revokes every active session / refresh token for one identity across all Environments, forcing re-authentication everywhere — the primary incident-response action for a suspected-compromised account. Does not deactivate or delete the identity; profile, memberships, and assignments are untouched. An optional reason is recorded on the session.all_revoked audit row, and the count of revoked sessions is returned. Returns 404 when the identity is not found.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability identities.manageIdentities

Manage end-user identities across the account. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Request body

application/json

reasonstring Optional

Optional human-readable reason recorded on the audit row (e.g. 'phishing-reported', 'password-compromise', 'policy-change'). Surfaces in the identity's activity feed during incident review.

max length 200

Responses

application/json

  • dataRevokeSessionsResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

RevokeSessionsResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/identities/value/revoke-sessions" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'
Response
{
  "data": {
    "message": "string",
    "revoked_count": 0
  }
}
 Related endpoints
GETList identities in Account
POSTCreate an Account identity
POSTBulk-create Account identities
GETGet directory counts for the Account
GETGet an Account identity
PATCHUpdate an Account identity profile
PATCHSet Account-wide is_active flag
POSTErase an identity (GDPR/CCPA right to be forgotten)
POSTAdmin-trigger a password reset email
POSTRe-send email verification
GETList audit events for an Account identity
POSTAdd an identity to an Environment (create EnvironmentMembership)
POSTBulk-attach EnvironmentMemberships for the Add-from-directory picker
DELETERemove an identity from an Environment (revoke EnvironmentMembership)
 Was this page helpful?

Tell us how we can improve this guide.

Canopy