Deactivate a User
POST {{baseUrl}}/api/v1/users/:userId/lifecycle/deactivate
Deactivates a user. This operation can only be performed on users that do not have a DEPROVISIONED
status. While the asynchronous operation (triggered by HTTP header Prefer: respond-async
) is proceeding the user's transitioningToStatus
property is DEPROVISIONED
. The user's status is DEPROVISIONED
when the deactivation process is complete.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
sendEmail | boolean |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
""