Teams

Teams decide which services a reader or editor can see. This page explains how they work and how to manage them.

Roles: Only an admin can create, edit and delete teams. Administrators are exempt from team scoping.

Concepts#

  • A team has a name, a list of member logins and a list of services.
  • Only editor and reader users can be members. An admin is rejected, because admins always see every service.
  • A user can belong to any number of teams, and a service can belong to any number of teams.
  • A user's visible services are the union of the services of all teams the user belongs to.

What team scoping restricts#

Scoping covers more than the left menu. A user who is not in a team that covers a service is refused direct access to that service's API routes too: versions, overlays, environments, Try-It and so on. Routes without an owning service, such as user administration, are not affected.

Warning: A reader or editor who is in no team sees no services at all. When you enable teams on an existing installation, expect every such user to lose access until an administrator adds them to a team. There is no automatic "everyone in one team" migration.

Managing teams#

Open Teams in the top menu (/teams). The table shows team name, member logins and service names, with Edit and Delete per row. Above it a filter form accepts team name, member login and service name (all case-insensitive substrings, applied on the server).

Create team opens a form with a name field and two scrollable checkbox lists: one with every editor and reader user, one with every registered service. Saving replaces the team's members and services with the checked ones.

Creating teams is limited by the max_teams limit of your license.

Behavior to know#

  • Deleting a team removes its member and service rows automatically.
  • Deleting a user or a service does not clean up teams; a team simply stops resolving a login or service that no longer exists.
  • If a member is promoted to admin, their team rows become inert at once.
  • SSO providers can place new or returning users into teams automatically. See Single Sign-On (SSO).
  • When you create a service in the UI, you can choose the teams that get access to it.

Next steps#

Screenshots

Last updated: