Skip to content
RallyHere Docs

Queue Person For Purge

POST
/users/v1/person/{person_id}/purge

Queue a person for purging. This can occur up to a configured amount of time in the future or can occur immediately depending on suggested_purge_time.

Required Permissions:

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

Authorizations

Parameters

Path Parameters

person_id
required
string format: uuid

Request Body required

Purge request to purge a person from the system. This will remove all data about that player from the system.

object
suggested_purge_time

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

string format: date-time

Responses

202

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 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_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string