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
externalId
string
groupType
enum<string>
Available options:
GROUP_TYPE_UNSPECIFIED,
GROUP_TYPE_OPEN,
GROUP_TYPE_CLOSED,
GROUP_TYPE_RESTRICTED
name
string
roleId
integer<int64>
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>
userIds
string[]

Response

Response containing the newly created team group.

group
TeamGroup · object

A Team Group entity.