Types

Role

A role of your organisation or a global role, with the ids of the permissions it grants.

idrequired
integer
The role id.
namerequired
string | null
The role's unique name. No other role, even a deleted one, can share it.
labelrequired
string
The role's display label. Unique among your organisation's roles, ignoring case.
descriptionrequired
string | null
The role's description.
globalrequired
boolean
Whether the role belongs to the platform rather than your organisation. Global roles are read-only. Read-only.
permission_idsrequired
integer[]
The ids of the permissions the role grants, ascending. Change them with the role's permissions set. Read-only.
created_atrequired
string | null (date-time)
When the role was created.
updated_atrequired
string | null (date-time)
When the role last changed.

Used by (4)