Role is a datatype for information about a role.

Table: Role

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2024
colorstring   The color associated with the role.
descriptionstring   A description of the role.
displayNamestringyes  The display name of the role.
groupsGroupyes  The groups related to the role. See Group.
groupsV2multipleyes  The groups related to the role. The multiple datatype consists of (search: string, userId: string, searchInRoles: boolean, onlyIncludeGroupsWithRestrictiveQueryPrefix: boolean, limit: integer, skip: integer): GroupResultSetType. See GroupResultSetType.
idstringyes  The unique identifier for the role.
organizationPermissionsOrganizationPermissionyes  The organization permissions given to the role. See OrganizationPermission.
groupsCountintegeryes  The number of groups related to the role.
systemPermissionsSystemPermissionyes  The system permissions given to the role. See SystemPermission.
users[User]yes  A list of users assigned the role. See User.
usersCountintegeryes  The number of users assigned the role.
viewPermissionsPermissionyes  The view permissions given to the role. See Permission.