> ## Documentation Index
> Fetch the complete documentation index at: https://developer.upsun.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Administer teams

> Manage team access and permissions across all your projects and organizations.

> [!NOTE]
>
> **Feature Availability**
>
> This feature is available as part of the Advanced User Management add-on. You can [upgrade your organization to this add-on](https://developer.upsun.com/docs/administration/billing/add-on-subscription#upgrade-to-the-advanced-user-management-add-on) in the Console.
>
> For details about the other features included in this add-on, see the [Advanced User Management add-on](https://developer.upsun.com/docs/administration/billing/add-on-subscription#advanced-user-management-add-on) help topic section; for pricing information, see the [Upsun pricing](https://upsun.com/pricing/) page.

Organizations on Upsun Cloud are made up of both [projects](https://developer.upsun.com/docs/projects.md) and [users](https://developer.upsun.com/docs/administration/users.md).
While organizations by themselves allow you to assign project and environment type permissions to individual users on individual projects,
having many users and many projects calls for another method to group common access control settings.

**Teams** provide a grouping that connects a subset of an organization's users to another subset of that organization's projects.
That relationship enables organization owners to set default project and environment type access settings for each user and project from one place.

There is no limit to the number of teams that can be defined within a single organization.

## Create a new team

As an organization owner or member with **Manage users** permissions,
you can create new teams.

Teams must belong to an organization, so [create one](https://developer.upsun.com/docs/administration/organizations.md) first.
You can create new organizations with different payment methods and billing addresses
and organize your projects as you want, but keep in mind that both users and teams are restricted to single organizations.

> [tab] Using the Console
>
> 1. Navigate to your existing organization.
> 2. Open the user menu (your name or profile picture).
> 3. Select **Teams** from the dropdown.
> 4. Click **+ Create team**.
> 5. Enter the information for your team. Only the team name is required at this point, but you can define environment type permissions now if you'd like.
> 6. Click **Create team**.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:create -o <ORGANIZATION_NAME>
>    ```
>
> 2. Enter a team name.
>
> 3. Define your team's project role (admin or viewer).
>
> 4. If your team has viewer rights on the project, define its role on each type of environment.
>
> 5. Enter `Y` to confirm.
>
> > [!NOTE]
> >
> > To view a list of all the existing teams in your organization, run the following command:
> >
> > ```bash theme={null}
> > upsun team:list -o <ORGANIZATION_NAME>
> > ```

## Delete an existing team

As an organization owner or member with **Manage users** permissions,
you can delete existing teams.

Note that deleting teams and deleting users are not equivalent.
Deleting a team will remove member access permissions to projects described by the team,
but it will *not* [remove users from the organization](https://developer.upsun.com/docs/administration/users.md#remove-a-user-from-an-organization) (or your billing).

> [tab] Using the Console
>
> 1. Navigate to your existing organization
> 2. Open the user menu (your name or profile picture).
> 3. Select **Teams** from the dropdown.
> 4. Find the team you want to delete under the **Manage teams** list,
>    then click \*\* More\*\*.
> 5. Click **Delete team**.
> 6. Click **Yes** to confirm.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:delete -o <ORGANIZATION_NAME>
>    ```
> 2. Select the team you want to delete.
> 3. Enter `Y` to confirm.

## Manage team settings

As an organization owner or member with **Manage users** permissions,
you can manage the settings of existing teams such as:

* [Team name](#team-name)
* [Environment type permissions granted to members on individual projects](#project--environment-type-permissions)
* [Team members](#team-members)
* [Project access](#team-access-to-projects)

### Team name

> [tab] Using the Console
>
> 1. In the upper left of the Console, navigate to your existing organization.
> 2. Click the organization name again and select **Teams** from the menu.
> 3. Find the team you want to rename under the **Manage teams** list,
>    then click \*\* More\*\*.
> 4. Click **Edit team**.
> 5. In the sidebar, click **Edit** and edit the team name.
> 6. Click **Save**.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:update -o <ORGANIZATION_NAME>
>    ```
> 2. Select the team you want to rename.
> 3. Enter the new name.
> 4. Confirm or adjust the team permissions.
> 5. Enter `Y` to confirm.

### Project and environment type permissions

The primary purpose of teams is to allow organizations to quickly apply, audit, and update project and environment type permissions for groups of users.

> [tab] Using the Console
>
> 1. In the upper left of the Console, navigate to your existing organization.
>
> 2. Click the organization name again and select **Teams** from the menu.
>
> 3. Find the team you want to modify under the **Manage teams** list,
>    then click \*\* More\*\*.
>
> 4. Click **Edit team**.
>
> 5. In the sidebar, you can:
>
>    * Assign **Project permissions** by selecting the check box to make team members *Project admins* of every project added to the team.
>    * Assign **Environment type permissions** by using the dropdowns to grant *No access*, *Viewer*, *Contributor*, or *Admin* rights to team members for *Production*, *Staging*, and *Development* project environment types.
>
> 6. Click **Save**.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:update -o <ORGANIZATION_NAME>
>    ```
> 2. Select the team whose permissions you want to update.
> 3. Confirm or adjust the team name.
> 4. Adjust the team permissions.
> 5. Enter `Y` to confirm.

### Team members

#### Add users to a team

To join a team, a user must already have been added [to the organization](https://developer.upsun.com/docs/administration/users.md#manage-organization-access),
where their [organization permissions](https://developer.upsun.com/docs/administration/users.md#organization-permissions) are defined.

> [tab] Using the Console
>
> 1. In the upper left of the Console, navigate to your existing organization.
> 2. Click the organization name again and select **Teams** from the menu.
> 3. Find the team you want to modify under the **Manage teams** list,
>    then click \*\* More\*\*.
> 4. Click **Add user**.
> 5. Locate and select organization users from the dropdown.
> 6. In the sidebar click the **Edit** link, and edit the team name.
> 7. Click **Add users**.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:user:add -o <ORGANIZATION_NAME>
>    ```
>
> 2. Select the team you want to add a user to.
>
> 3. Enter the user's email address.
>
> 4. Enter `Y` to confirm.
>
> > [!NOTE]
> >
> > To view a list of all the users on a team, follow these steps:
> >
> > 1. Run the following command:
> >
> >    ```bash theme={null}
> >    upsun team:user:list -o <ORGANIZATION_NAME>
> >    ```
> >
> > 2. Select the team whose users you want to display.

#### Remove users from a team

Note that deleting users from teams and deleting users from organizations are not equivalent.
Deleting users from a team will remove member access permissions to projects described by the team,
but it will *not* [remove users from the organization](https://developer.upsun.com/docs/administration/users.md#remove-a-user-from-an-organization) (or your billing).

> [tab] Using the Console
>
> 1. In the upper left of the Console, navigate to your existing organization.
> 2. Click the organization name again and select **Teams** from the menu.
> 3. Find the team you want to modify under the **Manage teams** list,
>    then click \*\* More\*\*.
> 4. Click **Edit team**.
> 5. Find the user you want to remove under the **USERS** tab view,
>    then click \*\* More\*\*.
> 6. Click **Remove user**.
> 7. Click **Yes** to confirm.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:user:delete -o <ORGANIZATION_NAME>
>    ```
> 2. Select a team.
> 3. Select the user you want to remove from the team.
> 4. Enter `Y` to confirm.

### Team access to projects

#### Adding projects to a team's access

> [tab] Using the Console
>
> **Option 1: Add projects to team with from Team settings**
>
> 1. In the upper left of the Console, navigate to your existing organization.
> 2. Click the organization name again and select **Teams** from the menu.
> 3. Find the team you want to modify under the **Manage teams** list,
>    then click \*\* More\*\*.
> 4. Click **Edit team**.
> 5. Click **+ Add projects**.
> 6. Select **All projects**, or choose individual projects from the dropdown.
>    > [!NOTE]
>    >
>    > **All projects** refers to all existing projects.
>    > Any future project you create will need to be added to the team manually.
> 7. Click **Add to team**.
>
> **Option 2: Add teams to project from project's Access settings**
>
> 1. Navigate to your existing organization.
> 2. Select the project you want to add to the existing team.
> 3. Navigate to the project's settings by clicking the \*\* Settings\*\* icon.
> 4. Click **Access** settings under **Project settings** in the sidebar.
> 5. Select the **TEAMS** tab in the **Access** list view.
> 6. Click **+Add to projects**.
> 7. Select **All teams**, or choose individual teams from the dropdown.
>    > [!NOTE]
>    >
>    > **All teams** refers to all existing teams.
>    > Any future team you create will need to be added to the project manually.
> 8. Click **Add to team**.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:project:add -o <ORGANIZATION_NAME>
>    ```
>
> 2. Select a team.
>
> 3. Select the project you want the team to access.
>
> 4. Enter `Y` to confirm.
>
> > [!NOTE]
> >
> > To view a list of all the projects added to a team, follow these steps:
> >
> > 1. Run the following command:
> >
> >    ```bash theme={null}
> >    upsun team:project:list -o <ORGANIZATION_NAME>
> >    ```
> > 2. Select the team whose projects you want to display.

#### Remove project from team's access

> [tab] Using the Console
>
> **Option 1: Remove projects from a team with from Team settings**
>
> 1. Navigate to your existing organization.
> 2. Open the user menu (your name or profile picture).
> 3. Select **Teams** from the dropdown.
> 4. Find the team you want to modify under the **Manage teams** list,
>    then click \*\* More\*\*.
> 5. Click **Edit team**.
> 6. Find the project you want to modify under the **PROJECTS** tab view,
>    then click \*\* More\*\*.
> 7. Click **Remove project**.
> 8. Select **All projects**, or choose individual projects from the dropdown.
> 9. Click **Yes** to confirm.
>
> **Option 2: Remove teams from a project from project's Access settings**
>
> 1. Navigate to your existing organization.
> 2. Select the project you want to add to the existing team.
> 3. Navigate to the project's settings by clicking the \*\* Settings\*\* icon.
> 4. Click **Access** settings under **Project settings** in the sidebar.
> 5. Find the team under the **TEAMS** tab view,
>    then click \*\* More\*\*.
> 6. Click **Remove team**.
> 7. Click **Yes** to confirm.

> [tab] Using the CLI
>
> 1. Run the following command:
>
>    ```bash theme={null}
>    upsun team:project:delete -o <ORGANIZATION_NAME>
>    ```
> 2. Select a team.
> 3. Select the project whose access you want to revoke for the team.
> 4. Enter `Y` to confirm.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.