Skip to content

Teams in Team Edition

DBeaverDevOps edited this page Sep 3, 2024 · 6 revisions

Table of contents

Overview

The Team Edition provides a comprehensive team management feature tailored for both web and desktop environments. This feature allows administrators to create and manage Teams effectively, grouping users together to facilitate project-based permissions and credential sharing.

In the Team Edition, the process of managing team memberships differs slightly between the web and desktop interfaces, primarily in the user interface layout.

Team creation

To create a new Team, follow these steps:

Web interface:

  1. As administrator, go to the Settings -> Administration -> Access Management -> Teams.
  2. Click on the + Add button.
  3. Fill in the necessary details in the provided fields.

Desktop interface:

  1. As administrator, navigate to Window -> Show View -> Administration.
  2. Select the Teams tab.
  3. Click on the + Create button.
  4. Specify the name of the Team in the window that appears.
  5. After creating the Team, select it from the list.
  6. Fill in the necessary details for the selected Team.
Field Name Description Additional Info
Team ID (only in the web interface) A unique identifier for the Team.
Team Name The name of the Team.
Description (only in the web interface) A brief description of the Team and its purpose.
Parameters Additional parameters based on the authentication provider. Read more about Integration with Identity Providers.

Predefined Team types

Team Edition includes all-users predefined Team type. This Team includes all users by default.

Integration with Identity Providers

You have the ability to integrate Teams with various identity providers. This integration allows for the utilization of roles and groups defined by your identity provider to manage Team memberships automatically.

Configuration steps

  1. When creating or editing a Team, navigate to the Parameters section.
  2. Here, depending on your identity provider, you can associate the Team with a specific identity attribute:
Provider Attribute Related articles
AWS AWS Role ARN AWS OpenID, AWS OpenID via Okta
SAML SAML Group ID SAML configuration
Microsoft Entra ID Microsoft Entra ID Group ID Microsoft Entra ID
Okta OpenID OKTA Group ID Okta OpenID

Automatic membership management

Once the integration is set up, whenever a user authenticated by the configured identity provider logs into Team Edition, the application will check for matching identity attributes. If there is a match with any of the defined parameters within Teams, the user will be automatically assigned to the appropriate Team.

Updating Team memberships

For the changes to take effect, especially in cases where group memberships are updated:

  • Users may need to log off and log back in through the Single Sign-On (SSO).
  • Alternatively, changes will take effect after the session timeout.

These actions ensure that the updated claims from the identity provider are received by Team Edition, thereby refreshing the Team memberships.

User Management

Web interface:

In the Users tab, administrators can manage Team memberships:

  • To add a user to the Team, click Edit, select the desired users, and then click Add.
  • To remove a user from the Team, select the user and click Delete.

Desktop interface:

In the Administration window, administrators can manage Team memberships:

  • To add a user to the Team, click + Add, select the desired users, and then click Ok.
  • To remove a user from the Team, select the user and click Delete.

Tip: One user can be a member of multiple teams.

Supervisor

Navigate to the Teams -> Users tab, here you can use the Supervisor checkbox to mark certain users as supervisors. Supervisors can view their team's queries in the Query Manager.

Note: The checkbox for assigning supervisor roles is exclusive to the web interface, but the capabilities granted by this permission are accessible in both the web and desktop interfaces.

After you have been assigned as a supervisor, you can view your team's queries by following these steps:

  1. Open the application and click on Tools in the toolbar.
  2. Select Query History from the dropdown menu.
  3. In the Query History window, you can toggle the Supervisor view on or off by using the Turn on/off supervisor view button .

Project Management

Web interface:

In the Projects tab, administrators can manage which projects are available to the Team:

  • To add a project to the Team, click Edit, choose the desired project, and then click Add.
  • To remove projects from the Team, select the project and click Delete.

Desktop interface:

In the Projects tab, administrators can manage which projects are available to the Team:

  • To add a project to the Team, click Edit, choose the desired project, and then click Add.
  • To remove projects from the Team, select the project and click Delete.

Tip: One project can be a part of multiple teams.

CloudBeaver Documentation

User Guide

Installation

Configuration

CloudBeaver AWS

CloudBeaver Enterprise Edition

Team Edition

Deployment

Clone this wiki locally