Add Person Restrictions

POST 
/users/v1/person/:person_id/restrictions

Add a new restriction to an existing person

Required Permissions:

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

Request

Path Parameters

person_id uuidrequired

application/json

Body

required

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

issuer_type RestrictionIssuerType (string)required

Possible values: [support, gm, admin, anticheat, punish_system, guardian, shop]

An enumeration.

issuer Issuer (string)required

The creator of the restriction

reason_detail Reason Detail (string)

Additional reason describing the restriction

Responses

201

Successful Response

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"
}

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...