Skip to content

Get All Roles For Sandbox

GET
/v1/sandbox/{sandbox_id}/role

Get all Roles for Sandbox, requires sandbox:config:view | sandbox:config:edit permission

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
roles
required

A list of all Roles

Array<object>

This mixin is meant to give a set of common properties to root config models

object
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
sandbox_id

ID of the Sandbox

string format: uuid
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
custom_data

Custom data associated with the resource

object
key
additional properties
string
login_loot_rewards

List of login loot rewards for this role

Array<object>
default:
object
loot_id
required

Loot ID for this login loot reward tied to this role

string format: uuid
legacy_loot_id

Legacy loot ID for this login loot reward tied to this role

integer
role_id

Unique Identifier for this Role

string format: uuid
default: 8c5f7bd8-ca5f-44e6-91c6-df6f1c3dfaa7
legacy_role_id

Legacy role ID for this role

integer
auth_bypass

Auth bypass method for this role

string
Allowed values: none locked limited
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string