Skip to main content

Enable or Disable a User

Enable or Disable a User by ID.

PATCH
/api/scim/v2/Users/{id}

Headers

KeyValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer <API Token>

Path Parameter

  • id (required): User ID for the user to be updated.

Request Body

{
"Operations": [
{
"op": "replace",
"value": {
"active": true
}
}
]
}

To enable the user, set "active": true. To disable the user, set "active": false.

Example cURL

Replace {id} with the actual User ID you want to enable or disable:

curl --location --request PATCH 'http://localhost:8080/api/scim/v2/Users/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--data-raw '{
"Operations": [
{
"op": "replace",
"value": {
"active": true
}
}
]
}'

Responses

Status CodeDescriptionResponse
200User updated successfullyempty
400Invalid Requestempty
401Unauthorizedempty
500Internal Server Errorempty