POST /api/v1/users/{userId}/lifecycle/deactivate
Deactivates a User.
This operation can only be performed on Users that do not have a DEPROVISIONED status.
- The User's
transitioningToStatusproperty isDEPROVISIONEDduring deactivation to indicate that the user hasn't completed the asynchronous operation. - The User's status is
DEPROVISIONEDwhen the deactivation process is complete.
Important: Deactivating a User is a destructive operation. The User is deprovisioned from all assigned apps, which might destroy their data such as email or files. This action cannot be recovered!
You can also perform user deactivation asynchronously. To invoke asynchronous user deactivation, pass an HTTP header Prefer: respond-async with the request.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
ID of an existing Okta user |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Prefer |
String | No |
Request asynchronous processing Possible values:
|
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
sendEmail |
Boolean | No |
Sends a deactivation email to the admin if Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.