Skip to content

Get All Roles

GET
/users/v1/role

Get all current roles. Including their custom_data and login_loot_rewards.

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

400

Bad Request

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string