Lifecycle Management
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.
POST
Create User Offboarding
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful Response
The unique UUID of the user offboarding.
The UUID of the offboarded identity.
The status of the offboarding.
Available options:
SCHEDULED, IN_PROGRESS, DIVERTED, CANCELLED, FAILED, EXPIRED, COMPLETED When the offboarding is scheduled to run, if scheduled.
When the offboarding was created.
When the offboarding was cancelled, if it was cancelled.
When the offboarding completed, if it has completed.