Get Queue Purge Status For Person
GET /users/v1/person/{person_id}/purge
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
Authorizations
Parameters
Path Parameters
person_id
required
string format: uuid
Responses
200
Successful Response
Purge response from a purge request
object
person_id
required
Person ID that will be purged
string format: uuid
purge_on
required
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
string format: date-time
created_on
required
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
string format: date-time
last_modified_on
required
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
string format: date-time
status
required
Status of the purge request
string
403
Error Codes:
auth_invalid_key_id
- Invalid Authorization - Invalid Key ID in Access Tokenauth_invalid_version
- Invalid Authorization - versionauth_malformed_access
- Invalid Authorization - malformed access tokenauth_not_jwt
- Invalid Authorizationauth_token_expired
- Token is expiredauth_token_format
- Invalid Authorization - {}auth_token_invalid_claim
- Token contained invalid claim value: {}auth_token_sig_invalid
- Token Signature is invalidauth_token_unknown
- Failed to parse tokeninsufficient_permissions
- Insufficient Permissions
object
auth_success
boolean
error_code
required
string
desc
required
string
404
Not Found
object
auth_success
boolean
error_code
required
string
desc
required
string
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string