Skip to content

User Group

A User Group is a regrouping of Users to manage the access rights of all these Users together.

Each User Group belongs to a Tenant and can only host Users who belong to the same Tenant.

Each User can belong to any number of User Groups, in any number of Tenants.

A User Group can manage access rights on all the child Tenants of the Tenant it belongs to.

You can read more about how to use User Groups in the access control guide.

User Group details

  • Name: a name to identify User Groups in a Tenant
  • Description: a text sharing information about the User Group.
  • Users: list of the Users who belong to this User Group
  • Role assignments: list of Roles paired with the scope in which the Role can be performed

User Groups Features

Feature State
List User Groups Available
Create User Group Available
Update User Group Available
Delete User Group Available
Assign Role to a User Group Available
Remove Role from a User Group Available

List User Groups

Permission

  • read.user group

Feature

  • Users can retrieve a list of User Groups in a Tenant

Create User Group

Permission

  • create.user group

Feature

  • Users can create a new User Group on a Tenant

Update User Group

Permission

  • update.user group

Feature

  • Users can update all information of a User Group

Delete User Group

Permission

  • delete.user group

Feature

  • Users can delete a User Group
  • This will make Users lose the access rights they had through this User Group

Assign Role to a User Group

Permission

  • update.user group

Feature

  • Users can assign roles to a User Group
  • each Role is applied with a scope (a specific Tenant or Folder)
  • the Role and scope pairing is called a Role Assignment
  • this will give more access rights to the Users in the User Group

Remove Role from a User Group

Permission

  • update.user group

Feature

  • Users can remove Role Assignments from a User Group
  • this will result in less access rights from the Users in the User Group