Skip to main content

Groups

The Groups page (/admin/groups) combines users into groups. If a group has roles, all members receive these roles. Using Auto-Assignment Rules, BasePeak.AI can also add users to a group automatically at sign-in, based on values from their identity provider.

It is available to users with the Administrator or User Manager role, and to users with a custom role that contains the group:manage permission. Managing a group's roles requires the user:manage permission; the Administrator and User Manager roles both contain it. A custom role with group:manage but without user:manage opens the groups but can neither manage roles nor pick members from the user list.

note

The Users and Groups pages only appear when an authentication provider is configured. For more information, see Auth Providers.

Group List​

The overview displays all groups in a table with the following columns:

ColumnDescription
NameThe group's unique internal name
Display NameThe name used for display
CreatedThe date the group was created

You can sort by any column by clicking its header. By default, the most recently created groups are at the top. Use the search field to filter the list by name or display name.

To open the detail view, click a row. If no groups exist yet, the message No groups found. appears.

Create a Group​

  1. Click Create Group
  2. Enter a unique name under Name (required field)
  3. Optional: Provide a Display Name and a Description
  4. Click Create Group

The new group's detail view then opens. There you assign roles to the group and add members.

Group Details​

A group's detail view is divided into the following cards:

CardContent
MembersThe group's users with their email address
Assigned RolesThe roles all members of the group receive
Auto-Assignment RulesThe rules that add users to the group automatically at sign-in

Using the buttons in the top right, you can Edit or Delete the group.

Members​

To add a user to the group:

  1. In the Members card, click Add Member
  2. Use the Search users... field to find an existing user (by email address or username)
  3. Click the desired user

To remove a member, click the trash icon next to the entry and confirm with Remove. If the group contains no members, the message No members in this group. appears.

If you remove a member who joined the group through an auto-assignment rule, BasePeak.AI does not add them back automatically at later sign-ins. If you add them again by hand, this block no longer applies.

You can also change a single user's groups on their detail page via Manage Groups (see Users).

Assign and Remove Roles​

All members of a group receive the group's roles, including members added through an auto-assignment rule. A group can have several roles; its members then hold all permissions of these roles combined. Which roles exist and what they allow is described in Users.

To assign a role to the group:

  1. In the Assigned Roles card, click Assign Role
  2. In the dialog, select the desired role; a short description explains each role

The role is assigned immediately. You can only assign and remove roles whose permissions you hold yourself. Other roles are disabled in the dialog and in the card.

To remove a role, click the trash icon next to it. If the group has no roles, the message No roles assigned. appears.

Which users receive a role through which group is shown in the role's detail view under Roles (/admin/roles).

Edit a Group​

Using Edit, you open the Edit Group dialog. There you change Display Name and Description. Confirm with Save. A group's Name cannot be changed here.

Delete a Group​

Using Delete, you remove the group after a confirmation prompt. The members' user accounts are preserved; the members do lose the group's roles and the access that was granted through the group.

BasePeak.AI refuses the deletion if the group is the only owner of a restricted agent. Add another owner there first (see Agents).

Auto-Assignment Rules​

With Auto-Assignment Rules, users join the group automatically at sign-in as soon as a value from their identity provider matches a rule. This lets you manage group membership, and with it the roles, centrally through the auth provider instead of adding each user by hand.

Each rule consists of a list of Values (e.g. group information from the identity provider) and a specification of which Auth Provider it applies to. If a user's identity provider supplies one of the stored values, the user becomes a member of the group. The comparison is case-insensitive. If no value matches any more later on, BasePeak.AI removes the automatic membership again.

To add a rule:

  1. In the Auto-Assignment Rules card, click Add Rule
  2. Under Auth Provider, choose either All Providers or a specific configured provider instance
  3. Under Seen at login, click the group values that this provider's users have brought along at sign-in (shown with the number of users). Enter further values under Values (comma-separated), separated by commas (e.g. value1, value2, ...)
  4. Click Create

Each rule is displayed with its values and its auth provider. With All Providers, the rule applies regardless of which provider instance a user signs in through; with a specific instance, it applies only to sign-ins through that instance. To delete a rule, click the trash icon and confirm with Delete. If no rules exist, the message No auto-assignment rules. appears.

note

Auto-assignment rules are evaluated on every action of a signed-in user against the groups in their session. New or changed rules apply within about a minute. Changes to groups in the identity provider apply once the session renews its token, at the latest at the next sign-in.

Notes​

  • Which Values a user brings along depends on what information their identity provider transmits at sign-in. Microsoft Entra ID sends group object IDs unless the app registration is set to send names. You configure the provider instances under Auth Providers.
  • To take over groups from Microsoft Entra ID, see Groups from Microsoft Entra ID.
  • If the last administrator receives that role through a group, BasePeak.AI refuses to remove them from the group, to remove the Administrator role from the group, or to delete the group.
  • You manage individual users, their directly assigned roles, and custom roles under Users.