POST /api/v1/users/{id}/lifecycle/suspend
Suspends a user. Perform this operation only on users with an ACTIVE status. The user has a SUSPENDED status when the process completes.
Suspended users can't sign in to Okta. They can only be unsuspended or deactivated. Their group and app assignments are retained.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user |
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.