Skip to main content

Role

Information about a role.

Properties

NameTypeDescriptionNotes
all_rolesboolA flag indicating if administrators with this role can manage all roles and all users.[optional]
default_roleboolA flag indicating if this role is one of the default roles.[optional]
descriptionstrThe description of the role.[optional]
group_idsList[str]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]
group_managementstrThe type of the group management. Defaults to ALL if not provided.[optional]
idstrThe UUID of the role.[optional]
managed_rolesList[Role]If allRoles is false, this attribute lists the roles and administrators in these roles that can be administered by administrators with this role. Administrators will also be able to manage end users.[optional]
namestrThe name of the role.
permissionsList[Permission]A list of the permissions assigned to this role.[optional]
role_typestrThe type of the role.
super_administratorboolA flag indicating if this role is a super administrator.[optional]

Example