Get Queue Purge Status For Person

GET 
/users/v1/person/:person_id/purge

Get the purge status for a person.

Required Permissions:

• For any person (including themselves) any of: purge:*:*, purge:person:admin

Request

Path Parameters

person_id uuidrequired

Responses

200

Successful Response

application/json

Schema

Schema

person_id uuidrequired

Person ID that will be purged

purge_on date-timerequired

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

created_on date-timerequired

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

last_modified_on date-timerequired

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

status Status (string)required

Status of the purge request

Example (from schema)

{
  "person_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "purge_on": "2024-07-29T15:51:28.071Z",
  "created_on": "2024-07-29T15:51:28.071Z",
  "last_modified_on": "2024-07-29T15:51:28.071Z",
  "status": "string"
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...