Get User Offboarding
Get a user offboarding by ID. status is scheduled before it starts and in-progress while it runs. It ends as completed, failed, or cancelled, and can also be diverted or expired.
Reading offboardings needs permission to view them. Of the built-in roles, Admin and Read Only Admin have it. Anyone else gets 403. An unknown ID returns 404.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The UUID of the user offboarding.
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.