Types

Permission

A permission that can be put on a role.

idrequired
integer
The permission id.
keyrequired
string
The permission key.
namerequired
string | null
The permission's name, the value a token owner's permissions are compared by.
labelrequired
string
The permission label.
descriptionrequired
string | null
What the permission allows.
categoryrequired
string | null
The label of the category the permission is listed under.
levelrequired
integer
The permission's level. A higher level is more powerful. Read-only.
creation_defaultrequired
boolean
Whether the permission is in your organisation's default set for new users. Change the set with PUT /roles/permissions/creation-defaults.
created_atrequired
string | null (date-time)
When the permission was created.
updated_atrequired
string | null (date-time)
When the permission last changed.

Used by (3)