Skip to main content

Role

Information about a role.

Properties

NameTypeDescriptionNotes
AllRolesbool?A flag indicating if administrators with this role can manage all roles and all users.[optional]
DefaultRolebool?A 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]
GroupManagementstringThe 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]
RoleTypestringThe type of the role.
SuperAdministratorbool?A flag indicating if this role is a super administrator.[optional]