Skip to content
RallyHere Docs

Create Role

POST
/v1/sandbox/{sandbox_id}/role

Create Role, requires sandbox:config:edit permission

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Request Body required

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

object
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: f7e8d109-b906-4751-abb0-d5ca946df1f0
legacy_role_id

Legacy role ID for this role

integer
auth_bypass

Auth bypass method for this role

string
Allowed values: none locked limited

Responses

201

Successful Response

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: f7e8d109-b906-4751-abb0-d5ca946df1f0
legacy_role_id

Legacy role ID for this role

integer
auth_bypass

Auth bypass method for this role

string
Allowed values: none locked limited

422

Validation Error

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