1. Docs
  2. API Reference
  3. Revoke a SCIM token

Revoke a SCIM token

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-tokens/{id}

Revokes a SCIM token by id within the current Environment by marking it inactive; IdP requests presenting it stop validating immediately. Returns 204 with no body.

Authentication

Bearer TokenAuthorization

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

Requires capability sso.manageSecurity

Manage SSO connections, domains, and directory sync. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

Token revoked — IdP provisioning requests using it stop validating immediately

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.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-tokens/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Token revoked — IdP provisioning requests using it stop validating immediately

(empty body)
 Related endpoints
GETList active SCIM tokens for the Environment
POSTMint a SCIM bearer token for the Environment
GETRecent SCIM sync activity for the Environment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy