Offboard people

Offboard a list of people. A person is only eligible for offboarding completion when:

1. They are an ex-employee.
2. All of the person’s monitored accounts are deactivated or manually overwritten as such.
3. All of a person’s custom offboarding tasks have been completed. All of the person’s unmonitored accounts will be automatically marked as deactivated when they are offboarded. If the person has unfinished offboarding tasks those will NOT automatically be completed and offboarding them will fail.

POST /people/offboard

Offboard people

cURL

curl --request POST \
  --url https://api.vanta.com/v1/people/offboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "acknowledgerId": "<string>",
      "id": "<string>"
    }
  ]
}
'

200

{
  "results": [
    {
      "id": "65e1efde08e8478f143a8ff9",
      "status": "SUCCESS"
    },
    {
      "id": "OTHER_USER_ID",
      "status": "ERROR",
      "message": "Invalid Input"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

updates · object[] · required

List of the people to offboard.

Required array length: 1 - 1000 elements

Show child attributes

Response

200 - application/json

Ok

results · object[] · required

List of results matching the length and order of the request

Option 1

Option 2

Show child attributes