Skip to main content

The Team

A team is a group of users who collaborate, with its own roles and members. It's the main way access to work is organized: a user's role on a team shapes what cases and clients they can see and do.

Teams are a facade over Group

A team is a specialized Group — internally, a group with group_type = team. That's why team endpoints live under Entity Management and use a {group} path parameter. The team surface is still evolving; treat the API Reference as the source of truth for the exact fields.

How you address it​

/entitymanagement/v1/teams                     # list, create
/entitymanagement/v1/teams/{group}             # retrieve, update, delete
/entitymanagement/v1/teams/{group}/members     # manage membership
/entitymanagement/v1/teams/{group}/roles       # manage team roles
/entitymanagement/v1/teams/{group}/effective-permissions

A team can also be used as a scope (send its scopeId in X-Scope) so that requests are narrowed to what that team can see.

Members and roles​

  • Members — the users who belong to the team.
  • Roles — capability sets assigned on the team. A user's role determines which actions they can take on entities the team is responsible for. See Users, Roles & Permissions for assigning roles and Permissions for how they resolve.

Relationships​

  • Is a Group (group_type = team); general-purpose groups use /entitymanagement/v1/groups.
  • Contains member users.
  • Belongs to a tenant.
  • Carries the shared sub-resources under /entitymanagement/v1/team/{id}/….

See also​