Groups

The Groups tab of the Admin app is where you can view, add, and manage groups in the Instabase deployment. Groups are collections of users that can be assigned the same set of permissions defined at the group level.

View groups

Note

All users can view all groups, including seeing who the users and admins of the group are.

From the groups list (All apps > Admin > Groups), you can view all groups in the deployment. All groups are displayed in alphabetical order, but you can filter and search for specific groups:

  • To filter for groups you are a member or admin of, select Show only groups I belong to.

  • To search for a specific group, enter any part of the group’s name in the Search bar.

The groups list includes the following information:

  • Display name: A user-friendly name for the group. Multiple groups can have the same display name.

  • Internal name: A unique identifier for the group.

  • Description: A brief description of the group.

  • Members: The number of members in the group.

  • Admins: The names of the admins for the group. Up to three admins are visible by name in the groups list; additional admins are visible on the group’s details page.

Add a group

Info

Site admins or users with the manage groups permission can add new groups.

To add a group:

  1. From the Admin app, select Groups.

  2. Click Create new Group.

  3. In the Name field, add a unique identifier for the group. The name cannot contain whitespace characters.

  4. In the Display name field, add a display name for the group. This value can but does not need to match the Name value, and can contain whitespace characters.

  5. In the Description field, enter a brief description of the group, such as its intended usage.

  6. Optionally select Add me as a group admin to make yourself an admin of the group.

  7. Click Create.

Manage group members

Info

Group admins can manage their own group’s members. Site admins and users with the manage groups permission can manage any group’s group members.

Selecting a group from the groups list opens the group’s details page. The details page lists all members of the group as a searchable user list. From a group’s details page, you can:

  • Add a user or service account to a group.

  • Change a group member’s role.

  • Remove a user from a group.

To add a user to a group:

  1. From the Admin app, select Groups.

  2. Select the group from the groups list.

  3. Click Add users.

  4. Add the user as either a group member or group admin:

    • Add as a group member: Search for the username or service account name in the Member field, then select the name from the search results.

    • Add as a group admin: Search for the username or service account name in the Admin field, then select the name from the search results.

  5. Click Add.

To change a group member’s role:

  1. From the Admin app, select Groups.

  2. Select the group from the groups list.

  3. Search for or locate the user in the users list.

  4. In the user’s row, click the dropdown in the Role column and select either Member or Admin.

  5. Click Save.

To remove a member from a group:

  1. From the Admin app, select Groups.

  2. Select the group from the groups list.

  3. Search for or locate the user in the users list.

  4. In the user’s row, click the X icon.

  5. Click Save.

Manage a group

Info

Group admins can manage their own group. Site admins and users with the manage groups permission can manage any group.

From a group’s details page, you can also edit the group’s information and delete the group.

To edit a group’s information:

  1. From the Admin app, select Groups.

  2. Select the group from the groups list.

  3. Click the three-dot icon and select Edit group.

  4. Edit the group’s internal name, display name, and description as needed.

  5. Click Save.

To delete a group:

  1. From the Admin app, select Groups.

  2. Select the group from the groups list.

  3. Click the three-dot icon and select Delete group.

  4. Click Delete to confirm.

Using groups to manage roles and permissions

Because roles in Instabase are defined by managing permissions and entitlements, you can use groups to assign role-related permissions to multiple users at once. For example, you can grant all users within a group read access to the Metrics app. Any permissions granted to a group are granted to all users assigned to that group.

Groups can be assigned the following types of permissions:

  • Site permissions: Site permissions are used to grant the ability to perform actions otherwise restricted to site admins, such as managing users or group memberships. See the site permissions documentation for details.

  • App permissions: App permissions are used to grant access to applications otherwise restricted to site admins, such as the Deployment Manager, Metrics, or Audit Logs apps. See the app permissions documentation for details.

  • Space and subspace permissions: Groups can be assigned space and subspace-specific permissions within organization spaces. See the spaces documentation for details.

Info

Group permissions are granted at the site level, meaning group members can be given access to data or entities anywhere on the site, not just within a particular space.