Create User Offboarding
Trigger or schedule an offboarding for an identity. Omit scheduled_at to run immediately, or provide a future datetime to schedule it. Omit workflow_config_id to use the offboarding workflow configuration your organization has selected for automatic offboarding.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
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.
The UUID of the offboarding workflow configuration to run. Omit to use the configuration your organization has selected for automatic offboarding. This field is only accepted for organizations with the multiple offboarding workflows feature; a request that includes it is rejected otherwise.
Response
Successful Response
The unique UUID of the user offboarding.
The UUID of the offboarded identity.
The status of the offboarding.
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.
The UUID of the offboarding workflow configuration this offboarding runs under, or null when none can be named for it. This field is only returned for organizations with the multiple offboarding workflows feature.