Get All Roles

GET 
/users/v1/role

Get all current roles. Including their custom_data and login_loot_rewards.

Required Permissions:

• For any player (including themselves) : role:read

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

role_id Role Id (string)required

Unique Role ID

legacy_role_id Legacy Role Id (integer)

Default value: 0

Legacy role ID

custom_data object

Default value: [object Object]

Custom data for the role

auth_bypass RoleAuthBypass (string)

Possible values: [none, limited, locked]

Role auth bypass options

login_loot_rewards

object[]

List of loot ids that are fulfilled for the player when they begin a new inventory session

Array [

loot_id Loot Id (string)

Loot ID

legacy_loot_id Legacy Loot Id (integer)required

Legacy Loot ID

]

• ]

Example (from schema)

[
  {
    "role_id": "string",
    "legacy_role_id": 0,
    "custom_data": {},
    "auth_bypass": "none",
    "login_loot_rewards": [
      {
        "loot_id": "string",
        "legacy_loot_id": 0
      }
    ]
  }
]

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

Loading...