Skip to main content
POST
Create an Offboarding Request

Authorizations

Authorization
string
header
required

Access Token Authentication

Body

application/json

A request to offboard an Entity

entityId
string<uuid>

The id of the Entity to offboard

Response

Created

An Offboarding Request

data
object

Represents an entity in the offboarding process.

id
string<uuid>

The id of the Offboarding Request

principalId
string<uuid>

The id of the Principal that initiated the Offboarding Request

status
enum<string>
Available options:
Canceled,
Failed,
Pending,
Succeeded