Suspend User
okta.suspend_user
ActionBusiness appsconnection required
Calls the Okta API with the connection's credentials.
Suspend an active user so they cannot sign in, while keeping their account, group memberships and app assignments intact.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Okta
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- org_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
user_id The user to act on — an Okta user id, their login, or the login shortname. | string | Yes | — | — | 00u1a2b3c4D5e6F7g8h9 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"user_id": "00u1a2b3c4D5e6F7g8h9"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
suspended True once Okta accepted the suspension. | boolean | — |
user_id The user that was suspended. | string | — |
{
"suspended": false,
"user_id": ""
}See Suspend User run in a workflow.
In a technical demo we add the Okta connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.