Create Role
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"parentRoleId": 1,
"description": "<string>",
"name": "<string>",
"parentRoleName": "<string>",
"permissions": [
"<string>"
],
"teamId": 1
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1"
payload = {
"parentRoleId": 1,
"description": "<string>",
"name": "<string>",
"parentRoleName": "<string>",
"permissions": ["<string>"],
"teamId": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentRoleId: 1,
description: '<string>',
name: '<string>',
parentRoleName: '<string>',
permissions: ['<string>'],
teamId: 1
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1', 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/custom-roles/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'parentRoleId' => 1,
'description' => '<string>',
'name' => '<string>',
'parentRoleName' => '<string>',
'permissions' => [
'<string>'
],
'teamId' => 1
]),
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/custom-roles/v1"
payload := strings.NewReader("{\n \"parentRoleId\": 1,\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"parentRoleName\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"teamId\": 1\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentRoleId\": 1,\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"parentRoleName\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"teamId\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentRoleId\": 1,\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"parentRoleName\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"teamId\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": 1
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Role Management Service
Create Role
Creates a new custom role.
Create Role
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"parentRoleId": 1,
"description": "<string>",
"name": "<string>",
"parentRoleName": "<string>",
"permissions": [
"<string>"
],
"teamId": 1
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1"
payload = {
"parentRoleId": 1,
"description": "<string>",
"name": "<string>",
"parentRoleName": "<string>",
"permissions": ["<string>"],
"teamId": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentRoleId: 1,
description: '<string>',
name: '<string>',
parentRoleName: '<string>',
permissions: ['<string>'],
teamId: 1
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1', 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/custom-roles/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'parentRoleId' => 1,
'description' => '<string>',
'name' => '<string>',
'parentRoleName' => '<string>',
'permissions' => [
'<string>'
],
'teamId' => 1
]),
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/custom-roles/v1"
payload := strings.NewReader("{\n \"parentRoleId\": 1,\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"parentRoleName\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"teamId\": 1\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentRoleId\": 1,\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"parentRoleName\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"teamId\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/custom-roles/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentRoleId\": 1,\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"parentRoleName\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"teamId\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": 1
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Body
application/json
- Option 1
- Option 2
- Option 3
Request for creating a custom role.
The parent role id.
Required range:
x >= 0Human-readable description.
Display name.
The parent role name.
List of permissions.
List of permissions.
Team identifier.
Required range:
x >= 0Response
Response returned after successfully creating a custom role.
Unique identifier.
Required range:
x >= 0Was this page helpful?
⌘I