Get Person Restrictions For Self

GET 
/users/v1/person/me/restrictions

Get Restrictions for your person. These same restrictions apply to all players associated with the person

Required Permissions:

• For any person (including themselves) any of: user:*, user:restriction:read:any

• For the person themselves : user:restriction:read:self

Responses

200

Successful Response

application/json

Schema

Schema

restrictions

object[]

List of restrictions applied to a user

Array [

type RestrictionType (string)required

Possible values: [account_ban, account_lockout, account_pending_deletion, account_deny_auth]

Restrictions that can be applied to a player. Resitrictions are applied to a player by an admin and often types indicates that the player is banned.

reason RestrictionReasonCode (string)

Possible values: [cheating_autodetected, speedhack_autodetect, other, cheating_observed, cheating_reported_by_player, threats, language, griefing, fraud, revoke_failed, unknown, guardian, issuer_process, account_migration, user_request, maintenance, pending_deletion]

An enumeration.

expiration date-time

Date the restriction expires. Null means the restriction is permanent

]

Example (from schema)

{
  "restrictions": [
    {
      "type": "account_ban",
      "reason": "cheating_autodetected",
      "expiration": "2024-07-29T15:51:28.071Z"
    }
  ]
}

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

Error Codes:

• user_not_found - User 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"
}

Loading...