Skip to main content
POST
/
v1
/
offboarding
/
entities
Create an Offboarding Request
curl --request POST \
  --url https://api.traxes.io/connect/v1/offboarding/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "data": {
    "components": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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