DELETE /api/v1/users/{id}
Deletes a User permanently. This operation can only be performed on Users that have a DEPROVISIONED status. This action can't be recovered!
This operation on a User that hasn't been deactivated causes that User to be deactivated. A second delete operation is required to delete the User.
Note: You can also perform user deletion asynchronously. To invoke asynchronous user deletion, pass an HTTP header
Prefer: respond-asyncwith the request. This header is also supported by user deactivation, which is performed if the delete endpoint is invoked on a User that hasn't been deactivated.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
|
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Prefer |
String | No |
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.