Create User Offboarding

Trigger or schedule an offboarding for an identity using the domain's configured offboarding workflow. Omit scheduled_at to run immediately, or provide a future datetime to schedule it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The UUID of the identity to offboard.

When to run the offboarding, as an ISO 8601 datetime. Omit to trigger the offboarding immediately; provide a future datetime to schedule it.

Responses

400

The target identity is not a source-of-truth identity, or scheduled_at is in the past.

403

The caller lacks permission for this operation.

404

No identity exists with the given user_id in the caller's domain.

409

An offboarding is already scheduled or in progress for this identity.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json