1. Docs
  2. API Reference
  3. Deactivate a user

Deactivate a user

POST/portal/v1/accounts/{accountSlug}/users/{id}/deactivate

Deactivates an Account membership and immediately revokes the member's active dashboard sessions for this Account (deny-listing outstanding access tokens, plus a realtime force-logout) so the change takes effect at once. Cannot target yourself (400) or an Account owner (403); responds 404 when the user is not a member. Emits a user.deactivated audit entry.

Authentication

Bearer TokenAuthorization

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

Requires capability administrators.manageGovernance

Invite, deactivate, and remove administrators. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

application/json

  • dataMessageResponseDto*

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

MessageResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/users/value/deactivate" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "message": "string"
  }
}
 Related endpoints
GETList users in Account
GETGet Account users summary
GETGet a user
DELETERemove user from Account
POSTActivate a user
 Was this page helpful?

Tell us how we can improve this guide.

Canopy