Skip to main content
Update Team Group
curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2/{group_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "externalId": "<string>",
  "groupType": "GROUP_TYPE_UNSPECIFIED",
  "name": "<string>",
  "roleUpdate": {
    "action": {
      "actionType": "<string>",
      "setRoleId": {
        "value": 123
      }
    }
  },
  "scopeUpdate": {
    "action": {
      "actionType": "<string>",
      "setScopeId": {
        "value": "<string>"
      }
    }
  },
  "userUpdates": {
    "operation": {
      "add": {
        "userIds": [
          "<string>"
        ]
      },
      "operationType": "<string>"
    }
  }
}
'
{
  "group": {
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "externalId": "<string>",
    "groupId": 123,
    "groupOrigin": "GROUP_ORIGIN_UNSPECIFIED",
    "groupType": "GROUP_TYPE_UNSPECIFIED",
    "name": "<string>",
    "role": {
      "description": "<string>",
      "name": "<string>",
      "roleId": 123
    },
    "scope": {
      "scopeId": "<string>"
    },
    "teamId": 123,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

group_id
integer<int64>
required

Body

application/json

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

description
string
externalId
string
groupType
enum<string>
Available options:
GROUP_TYPE_UNSPECIFIED,
GROUP_TYPE_OPEN,
GROUP_TYPE_CLOSED,
GROUP_TYPE_RESTRICTED
name
string
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.