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>",
"name": "<string>",
"roleId": 1,
"scope": {
"scopeId": "<string>"
},
"teamId": 1,
"userIds": [
"<string>"
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2"
payload = {
"description": "<string>",
"externalId": "<string>",
"name": "<string>",
"roleId": 1,
"scope": { "scopeId": "<string>" },
"teamId": 1,
"userIds": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
externalId: '<string>',
name: '<string>',
roleId: 1,
scope: {scopeId: '<string>'},
teamId: 1,
userIds: ['<string>']
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'externalId' => '<string>',
'name' => '<string>',
'roleId' => 1,
'scope' => [
'scopeId' => '<string>'
],
'teamId' => 1,
'userIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"roleId\": 1,\n \"scope\": {\n \"scopeId\": \"<string>\"\n },\n \"teamId\": 1,\n \"userIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"roleId\": 1,\n \"scope\": {\n \"scopeId\": \"<string>\"\n },\n \"teamId\": 1,\n \"userIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"roleId\": 1,\n \"scope\": {\n \"scopeId\": \"<string>\"\n },\n \"teamId\": 1,\n \"userIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"group": {
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"externalId": "<string>",
"groupId": 1,
"name": "<string>",
"role": {
"description": "<string>",
"name": "<string>",
"roleId": 1
},
"scope": {
"scopeId": "<string>"
},
"teamId": 1,
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Create Team Group
Creates a new 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>",
"name": "<string>",
"roleId": 1,
"scope": {
"scopeId": "<string>"
},
"teamId": 1,
"userIds": [
"<string>"
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2"
payload = {
"description": "<string>",
"externalId": "<string>",
"name": "<string>",
"roleId": 1,
"scope": { "scopeId": "<string>" },
"teamId": 1,
"userIds": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
externalId: '<string>',
name: '<string>',
roleId: 1,
scope: {scopeId: '<string>'},
teamId: 1,
userIds: ['<string>']
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'externalId' => '<string>',
'name' => '<string>',
'roleId' => 1,
'scope' => [
'scopeId' => '<string>'
],
'teamId' => 1,
'userIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"roleId\": 1,\n \"scope\": {\n \"scopeId\": \"<string>\"\n },\n \"teamId\": 1,\n \"userIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"roleId\": 1,\n \"scope\": {\n \"scopeId\": \"<string>\"\n },\n \"teamId\": 1,\n \"userIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"roleId\": 1,\n \"scope\": {\n \"scopeId\": \"<string>\"\n },\n \"teamId\": 1,\n \"userIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"group": {
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"externalId": "<string>",
"groupId": 1,
"name": "<string>",
"role": {
"description": "<string>",
"name": "<string>",
"roleId": 1
},
"scope": {
"scopeId": "<string>"
},
"teamId": 1,
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Body
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.
Human-readable description of the team group.
External identifier for the group, used when the group is managed by an external identity provider.
Group type.
GROUP_TYPE_UNSPECIFIED, GROUP_TYPE_OPEN, GROUP_TYPE_CLOSED, GROUP_TYPE_RESTRICTED Unique display name for the new team group.
Identifier of the role to assign to this group.
x >= 0Scope assignment for a group. References an existing scope by ID. Scopes can be created via the Scopes API.
Show child attributes
Show child attributes
Team to associate the group with. If not set, uses the authenticated team.
x >= 0The user ids.
The user ids.
Response
Response containing the newly created team group.
A Team Group entity.
Show child attributes
Show child attributes
Was this page helpful?