The Role datatype includes settings various settings.

Table: Role

ParameterTypeRequired[a]DefaultDescription
idstringyes datatype role The unique identifier for the role.
displayNamestringyes The display name of the role.
colorstring  The color associated with the role.
descriptionstring  A description of the role.
viewPermissionsPermissionyes The view permissions given to the role.
systemPermissionsSystemPermissionyes The system permissions given to the role.
organizationPermissionsOrganizationPermissionyes The organization permissions given to the role.
groupsCountintegeryes The number of groups related to the role.
usersCountintegeryes The number of users assigned the role.
usersUseryes A list of users assigned the role.
groupsGroupyes The groups related to the role.

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.