Deprovision a user

DELETE

/scim/v2/directories/{directoryId}/Users/{id}

SCIM 2.0 (RFC 7644 §3.6). Deprovisions the user: access through this directory is deactivated and their sessions are revoked, while the identity record is kept. Returns 204 with no body. Errors use SCIM's error schema (RFC 7644 §3.12).

Path Parameters

directoryIdstring Required

The directory the SCIM token was minted for.

idstring Required

Responses

The user was deprovisioned; no body

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

Request

curl -X DELETE "https://auth.canopy-io.com/scim/v2/directories/value/Users/value"

Response

HTTP/1.1 204 The user was deprovisioned; no body

(empty body)

Was this page helpful?

Tell us how we can improve this guide.