Skip to main content
Update Team Group

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

group_id
integer<int64>
required

Unique identifier of the team group to update.

Required range: x >= 0

Body

application/json

Request to modify an existing team group's details, including its name, description, roles, users, and scope settings.

description
string

New human-readable description for the team group.

externalId
string

New external identifier for the group.

groupType
enum<string>

Group type.

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

New display name for the team group.

roleUpdate
RoleUpdate · object

Update the role assigned to the group. Either set a new role or clear the existing one.

scopeUpdate
ScopeUpdate · object

Update the scope assigned to the group. Either reference an existing scope by ID or clear the scope.

userUpdates
UserUpdates · object

Patch object for updating group user membership. Choose one operation: add, remove, or replace all users.

Response

Response containing the updated team group.

group
TeamGroup · object

A Team Group entity.