Role Model

type

enum<string>

Available options:

roles

Example:

"roles"

string

Example:

"scheme.owner"

attributes

object

Show child attributes

attributes.name

string

The role name

Example:

"Scheme Owner"

attributes.description

string

A description for the role

Example:

"Ability to manage all aspects of schemes"

attributes.custom

boolean

Whether the role is custom to an organisation (true) or is a standard system role (false)

Example:

false

attributes.launch_stage

enum<string>

The launch stage of the role. Alpha = initial testing, Beta = public testing, GA = general availability

Available options:

alpha,

beta,

ga

Example:

"beta"

attributes.permissions

string[]

Example:

[
  "schemes.create",
  "schemes.read",
  "schemes.update",
  "schemes.delete"
]