Skip to main content
Create Team Group

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

Request to create a new team group with specified name, description, roles, users, and optional scope filters. Can be associated with a specific team or the authenticated team.

description
string

Human-readable description of the team group.

externalId
string

External identifier for the group, used when the group is managed by an external identity provider.

groupType
enum<string>

Group type.

Available options:
GROUP_TYPE_UNSPECIFIED,
GROUP_TYPE_OPEN,
GROUP_TYPE_CLOSED,
GROUP_TYPE_RESTRICTED
name
string

Unique display name for the new team group.

roleId
integer<int64>

Identifier of the role to assign to this group.

Required range: x >= 0
scope
Scope · object

Scope assignment for a group. References an existing scope by ID. Scopes can be created via the Scopes API.

teamId
integer<int64>

Team to associate the group with. If not set, uses the authenticated team.

Required range: x >= 0
userIds
string[]

The user ids.

The user ids.

Response

Response containing the newly created team group.

group
TeamGroup · object

A Team Group entity.