Teams – General

Description and operation

General

A team is a shared owner of workspaces and environments. It has a handle, a name, a description and one region. You manage a team in the console, on the page Team settings, which shows the controls that your role can use.

The handle is the name of the team in every address. It has 3 to 39 characters: lowercase letters, digits and -, not at the start or end. No other team or account can use it. The handle and the region do not change. To move a team to another region, see Regions.

The tasks name the console. Every task has an API route. The SDKs have no method for teams: call the route in References with the SDK method request. The role rules are the same.

Roles

A team keeps at least one owner. The last owner cannot leave and cannot be removed.

Members

A member is active or paused. A paused member keeps the role and the row in the list, and the platform refuses the member on every route of the team. A pause or a removal takes effect in about 5 minutes. Access to git and to the registry follows within one minute.

An admin or an owner invites by email address. The invitation holds the address and the role, and is valid for 7 days. The platform sends the link by email, or the console shows it if the email cannot go out. Only the invited address can accept, after signing in to the console once. An open invitation can be withdrawn.

When an admin removes a member, the platform waits 7 days. Then it deletes the member's sessions with their chat transcripts, and workspaces in this team. Snapshots and environments stay. If the member joins again within 7 days, nothing is deleted. The page Team settings lists a waiting removal, and an admin can delete at once: Delete the resources of a removed member now. A region can switch the deletion off.

Limits

Tasks

Create a team

Reason for the task: Make an owner that a group can use.

Job set-up

• Access: you.
• Conditions: The handle is free. Show the regions lists the regions.
• References: POST /v1/teams, GET /v1/regions.

Procedure

1. Open the team switcher in the console and select New team.

2. Type the name in the field Team name.

3. Read the suggested handle in the field Handle. Change it if needed.

4. Select the region in the field Region.

5. Select Create team.

Close-out

1. Make sure that Team settings shows you as the only member, with the role owner.

Invite a member

Reason for the task: Give someone access to the team.

Job set-up

• Access: an admin or an owner. Only an owner can invite an owner.
• Conditions: You know the email address that the invitee signs in with.
• References: POST /v1/teams/{slug}/invites, DELETE /v1/teams/{slug}/invites/{id}.

Procedure

1. Open Team settings and find the section Members.

2. Type the address in the field Invite by email.

3. Select the role in the field Role.

4. Select Send invite.

5. If the page shows a link, send it to the invitee.

Close-out

1. Make sure that pending invitation lists the address and the role.

Accept an invitation

Reason for the task: Join a team that invited you.

Job set-up

• Access: the invited address.
• Conditions: The invitation is not older than 7 days. You have signed in to the console once.
• References: GET /v1/invites/{token}, POST /v1/invites/{token}/accept.

Procedure

1. Open the link from the email and sign in with the invited address.

2. Read the team name and the role.

3. Select Accept and join.

Close-out

1. Make sure that the team switcher lists the team.

Change the role of a member

Reason for the task: Give a member more or fewer rights.

Job set-up

• Access: an admin or an owner. An admin cannot change an owner or set the role owner.
• Conditions: The team keeps at least one owner.
• References: PATCH /v1/teams/{slug}/members/{email}.

Procedure

1. Open Team settings and find the member in the section Members.

2. Select the new role in the role list on the row.

Close-out

1. Make sure that the row shows the new role.

Pause a member

Reason for the task: Stop the access of a member and keep the member in the team.

Job set-up

• Access: an admin or an owner. An admin cannot pause an owner. Nobody can pause themselves.
• Conditions: The team keeps at least one active owner.
• References: POST /v1/teams/{slug}/members/{email}/pause.

Procedure

1. Open Team settings and find the member in the section Members.

2. Select the pause button on the row and select OK.

Close-out

1. Wait 5 minutes. Make sure that the row shows the label paused.

Restore access of a paused member

Reason for the task: Give a paused member access again.

Job set-up

• Access: an admin or an owner.
• Conditions: The member is paused.
• References: POST /v1/teams/{slug}/members/{email}/unpause.

Procedure

1. Open Team settings and find the paused member in the section Members.

2. Select the unpause button on the row and select OK.

Close-out

1. Wait 5 minutes. Make sure that the row does not show the label paused.

Remove a member

Reason for the task: End the membership of a member.

Job set-up

• Access: an admin or an owner. An admin cannot remove an owner.
• Conditions: The team keeps at least one owner.
• References: DELETE /v1/teams/{slug}/members/{email}, GET /v1/teams/{slug}/removals.

Procedure

1. Open Team settings and find the member in the section Members.

2. Select the remove button on the row.

3. Read the date in the confirmation and select OK.

Close-out

1. Wait 5 minutes. Make sure that the list does not show the member and pending removal does.

Delete the resources of a removed member now

Reason for the task: Delete the items of a removed member before the 7 days end.

Job set-up

• Access: an admin or an owner.
• Conditions: Team settings lists a pending removal for the handle.
• References: POST /v1/teams/{slug}/members/{email}/delete-now, GET /v1/teams/{slug}/removals.

Procedure

1. Open Team settings and find the member in the list of pending removals.

2. Select Delete now on the row.

3. Type the handle of the member in the field.

4. Select Delete now below the field.

Close-out

1. Make sure that the row says the deletion is on its way.

Leave a team

Reason for the task: End your own membership.

Job set-up

• Access: an active member. A paused member cannot leave.
• Conditions: If you are the last owner, first give the role owner to another member.
• References: DELETE /v1/teams/{slug}/members/{email}.

Procedure

1. Open Team settings and find your row in the section Members.

2. Select the leave button on your row and select OK.

Close-out

1. Make sure that the team switcher does not list the team.

Change the team name and profile

Reason for the task: Change how the team appears to its members and to the public.

Job set-up

• Access: any member for the name and the description; an admin or an owner for the public profile.
• Conditions: You are a member of the team.
• References: PATCH /v1/teams/{slug}, GET /v1/teams/{slug}/profile.

Procedure

1. Open Team settings, change the fields in the section Team and select Save changes.

2. Change the fields in the section Public profile. To show the profile to anyone, select Make this team public in the section Visibility.

3. Select Save changes.

Close-out

1. Open Team settings again. Make sure that the fields show the new values.

Delete a team

Reason for the task: Remove a team that nobody needs, and free its handle.

Job set-up

• Access: an owner.
• Conditions: You no longer need the workspaces, environments and sessions of the team.
• References: DELETE /v1/teams/{slug}.

Procedure

1. Open Team settings and find the section Danger zone.

2. Type the handle of the team in the field.

3. Select Delete this team.

Close-out

1. Make sure that the team switcher does not list the team.

Troubleshooting