Skip to main content
Create Team Group
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "externalId": "<string>",
  "groupType": "GROUP_TYPE_UNSPECIFIED",
  "name": "<string>",
  "roleId": 123,
  "scope": {
    "scopeId": "<string>"
  },
  "teamId": 123,
  "userIds": [
    "<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

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.