Role Document (Data API 17.4)
Document representing an access role.
| Property | Type | Constraints | Description |
|---|---|---|---|
description
|
String | The role description. | |
id
|
String | The role ID. | |
link
|
String | URL that is used to get this instance. This property is computed and cannot be modified. | |
user_count
|
Integer | Number of users assigned to the role. | |
user_manager
|
Boolean | Flag whether this role is allowed to manage users or other access roles. | |
users
|
[User] | The users assigned to the access role. Available through expands. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
