Skip to main content

Role

Information about a role.

Properties

NameTypeDescriptionNotes
allRolesBooleanA flag indicating if administrators with this role can manage all roles and all users.[optional]
defaultRoleBooleanA flag indicating if this role is one of the default roles.[optional]
descriptionStringThe description of the role.[optional]
groupIdsList<String>The UUIDs of groups associated with this role when Group Management is DEFINED. This attribute is ignored if Group Management is ALL or OWN.[optional]
groupManagementGroupManagementEnumThe type of the group management. Defaults to ALL if not provided.[optional]
idStringThe UUID of the role.[optional]
managedRolesList<Role>If allRoles is false, this attribute lists the roles and administrators in these roles thatcan be administered by administrators with this role. Administrators will also be able to manage end users.[optional]
nameStringThe name of the role.
permissionsList<Permission>A list of the permissions assigned to this role.[optional]
roleTypeRoleTypeEnumThe type of the role.
superAdministratorBooleanA flag indicating if this role is a super administrator.[optional]

GroupManagementEnum

NameValue
ALL"ALL"
DEFINED"DEFINED"
OWN"OWN"

RoleTypeEnum

NameValue
SITE_ADMINISTRATOR"SITE_ADMINISTRATOR"
ACCOUNT_MANAGER"ACCOUNT_MANAGER"