Administer teams
Back to home
On this page
Organizations on Platform.sh are made up of both projects and users. 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 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.
- Navigate to your existing organization.
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Click + Create team.
- 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.
- Click Create team.
-
Run the following command:
platform team:create -o ORGANIZATION_NAME
-
Enter a team name.
-
Define your team’s project role (admin or viewer).
-
If your team has viewer rights on the project, define its role on each type of environment.
-
Enter
Y
to confirm.
Note
To view a list of all the existing teams in your organization, run the following command:
platform 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 (or your billing).
- Navigate to your existing organization
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Find the team you want to delete under the Manage teams list, then click More.
- Click Delete team.
- Click Yes to confirm.
-
Run the following command:
platform team:delete -o ORGANIZATION_NAME
-
Select the team you want to delete.
-
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:
- It’s name
- The environment type permissions granted to members on individual projects
- Team members
- Project access
Team name
- Navigate to your existing organization.
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Find the team you want to rename under the Manage teams list, then click More.
- Click Edit team.
- In the sidebar click the Edit link, and edit the team name.
- Click Save.
-
Run the following command:
platform team:update -o ORGANIZATION_NAME
-
Select the team you want to rename.
-
Enter the new name.
-
Confirm or adjust the team permissions.
-
Enter
Y
to confirm.
Project & 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.
-
Navigate to your existing organization
-
Open the user menu (your name or profile picture).
-
Select Teams from the dropdown.
-
Find the team you want to modify under the Manage teams list, then click More.
-
Click Edit team.
-
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.
-
Click Save.
-
Run the following command:
platform team:update -o ORGANIZATION_NAME
-
Select the team whose permissions you want to update.
-
Confirm or adjust the team name.
-
Adjust the team permissions.
-
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, where their organization permissions are defined.
- Navigate to your existing organization.
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Find the team you want to modify under the Manage teams list, then click More.
- Click Add user.
- Locate and select organization users from the dropdown.
- In the sidebar click the Edit link, and edit the team name.
- Click Add users.
-
Run the following command:
platform team:user:add -o ORGANIZATION_NAME
-
Select the team you want to add a user to.
-
Enter the user’s email address.
-
Enter
Y
to confirm.
Note
To view a list of all the users on a team, follow these steps:
-
Run the following command:
platform team:user:list -o ORGANIZATION_NAME
-
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 (or your billing).
- Navigate to your existing organization.
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Find the team you want to modify under the Manage teams list, then click More.
- Click Edit team.
- Find the user you want to remove under the USERS tab view, then click More.
- Click Remove user.
- Click Yes to confirm.
-
Run the following command:
platform team:user:delete -o ORGANIZATION_NAME
-
Select a team.
-
Select the user you want to remove from the team.
-
Enter
Y
to confirm.
Team access to projects
Adding projects to a team’s access
Option 1: Add projects to team with from Team settings
- Navigate to your existing organization.
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Find the team you want to modify under the Manage teams list, then click More.
- Click Edit team.
- Click + Add projects.
- 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.
- Click Add to team.
Option 2: Add teams to project from project’s Access settings
- Navigate to your existing organization.
- Select the project you want to add to the existing team.
- Navigate to the project’s settings by clicking the Settings icon.
- Click Access settings under Project settings in the sidebar.
- Select the TEAMS tab in the Access list view.
- Click +Add to projects.
- 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.
- Click Add to team.
-
Run the following command:
platform team:project:add -o ORGANIZATION_NAME
-
Select a team.
-
Select the project you want the team to access.
-
Enter
Y
to confirm.
Note
To view a list of all the projects added to a team, follow these steps:
-
Run the following command:
platform team:project:list -o ORGANIZATION_NAME
-
Select the team whose projects you want to display.
Remove project from team’s access
Option 1: Remove projects from a team with from Team settings
- Navigate to your existing organization.
- Open the user menu (your name or profile picture).
- Select Teams from the dropdown.
- Find the team you want to modify under the Manage teams list, then click More.
- Click Edit team.
- Find the project you want to modify under the PROJECTS tab view, then click More.
- Click Remove project.
- Select All projects, or choose individual projects from the dropdown.
- Click Yes to confirm.
Option 2: Remove teams from a project from project’s Access settings
- Navigate to your existing organization.
- Select the project you want to add to the existing team.
- Navigate to the project’s settings by clicking the Settings icon.
- Click Access settings under Project settings in the sidebar.
- Find the team under the TEAMS tab view, then click More.
- Click Remove team.
- Click Yes to confirm.
-
Run the following command:
platform team:project:delete -o ORGANIZATION_NAME
-
Select a team.
-
Select the project whose access you want to revoke for the team.
-
Enter
Y
to confirm.