Roles document (Data API 20.9)

Document representing a list of access roles.

Property Type Constraints Description
data [Role]   The list of access roles.
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.
permissions RolePermissions   The permissions assigned to the access role. Available through expands.
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.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.