User roles endpoints keys
These keys are used with the RBAC API v1 roles
endpoints.
Key | Definition | 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 Permissions endpoints keys for possible content. | []
|
|
An array of UUIDs indicating which users and groups are directly assigned to the role. An empty array is valid. Users belonging to specified groups receive the role through the group, but those users aren't listed individually. | ["fc115750-555a-11e4-916c-0800200c9a66"]
|