User role keys
The following keys are used with the RBAC v1 API’s roles endpoints.
| Key | Explanation | Example |
|---|---|---|
id
|
An integer identifying the role. |
18
|
display_name |
The role's name as a string. |
"Viewers"
|
description
|
A string describing the role's function. |
"View-only permissions"
|
permissions
|
An array containing permission objects that indicate what permissions a role grants. An empty array is valid. See Permission keys for more information. |
[]
|
|
|
An array of UUIDs indicating which users and groups are directly assigned to the role. An empty array is valid. |
["fc115750-555a-11e4-916c-0800200c9a66"]
|