Update Team Group

PUThttps://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2/{group_id}

Updates the specified team group.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

group_id# int64required

Possible values: >= 0

Unique identifier of the team group to update.

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#GroupType

Group type.

Possible values: [GROUP_TYPE_UNSPECIFIED, GROUP_TYPE_OPEN, GROUP_TYPE_CLOSED, GROUP_TYPE_RESTRICTED]

name#string

New display name for the team group.

roleUpdate# object
Update the role assigned to the group. Either set a new role or clear the existing one.
scopeUpdate# object
Update the scope assigned to the group. Either reference an existing scope by ID or clear the scope.
userUpdates# object
Patch object for updating group user membership. Choose one operation: add, remove, or replace all users.

Response

200400401404500application/json

Response containing the updated team group.

group# object
A Team Group entity.