API ReferenceManagementScim Management
POST
/v1/mgmt/scim/key/revoke

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

tenantId*string
Length1 <= length
ssoId?string

The SSO configuration to revoke. Omit it to target the tenant's default configuration - it does NOT mean "every configuration", so a tenant with several SSO configurations keeps provisioning through the keys of the ones not named here. Call LoadSCIMAccessKeys first to see which configurations hold keys.

Lengthlength <= 254
revokeMode?"SCIM_KEY_REVOKE_MODE_DELETE" | "SCIM_KEY_REVOKE_MODE_DEACTIVATE"

How the keys are taken out of service. SCIM_KEY_REVOKE_MODE_DELETE (0, the default) deletes them permanently. SCIM_KEY_REVOKE_MODE_DEACTIVATE (1) disables them reversibly, so they can be restored later with Activate SCIM Access Keys.

Formatenum
Value in"SCIM_KEY_REVOKE_MODE_DELETE" | "SCIM_KEY_REVOKE_MODE_DEACTIVATE"

Revoke every SCIM access key of a tenant for the given SSO configuration, using a valid management key. This disables SCIM provisioning for that tenant until a new key is created and configured in the identity provider. Use revokeMode DEACTIVATE to suspend the keys reversibly instead of deleting them.

curl -X POST "https://api.descope.com/v1/mgmt/scim/key/revoke" \  -H "Content-Type: application/json" \  -d '{    "tenantId": "string"  }'
{  "revokedKeyIds": [    "string"  ]}
export interface Response {revokedKeyIds?: string[]}
Was this helpful?