Skip to content
RallyHere Docs

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

Authorizations

Responses

200

Successful Response

Array<object>

Role object that is used to define a role for a player

object
role_id
required

Unique Role ID

string
legacy_role_id

Legacy role ID

integer
custom_data

Custom data for the role

object
auth_bypass

Level of auth bypass for limited/locked modes

string
Allowed values: none limited locked
login_loot_rewards

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

Array<object>
default:

Login loot reward

object
loot_id

Loot ID

string
legacy_loot_id
required

Legacy Loot ID

integer

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