To deactivate a user with SCIM, either update the user's active value using a PATCH/PUT request or use the DELETE request to the Users/<user_id> endpoint.
PUT or PATCH /Users/<user_id>
Use PUT or PATCH to update the user. See Example: Update Users with SCIM for more info.
Request:
PATCH https://api.storychief.io/scim/v2/Users/1
Accept: application/scim+json
Content-Type: application/scim+json
Authorization: ••••••
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"path": "active",
"value": false
}
]
}
DELETE /Users/<user_id>
The DELETE request works the same as updating the active property on a User. The deleted User will still be returned by GET /Users with the active field set to false.
Expect a 404 error if there is no User matching the <user_id>.
For a full overview, see the schema reference here and the documentation about our SCIM implementation here.
Request:
DELETE https://api.storychief.io/scim/v2/Users/1
Accept: application/scim+json
Content-Type: application/scim+json
Authorization: ••••••
Response:
HTTP/1.1 204 No Content