Create Users - Coralogix Developer Docs

Create Users

curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userTemplate": {
    "accessType": {
      "accessType": "<string>",
      "permanentAccess": {},
      "temporaryAccess": {
        "expireAt": "2021-01-01T00:00:00.000Z"
      }
    },
    "allowedLoginMode": [],
    "firstName": "<string>",
    "lastName": "<string>",
    "username": "<string>"
  }
}
'

import requests

url = "https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members"

payload = { "userTemplate": {
        "accessType": {
            "accessType": "<string>",
            "permanentAccess": {},
            "temporaryAccess": { "expireAt": "2021-01-01T00:00:00.000Z" }
        },
        "allowedLoginMode": [],
        "firstName": "<string>",
        "lastName": "<string>",
        "username": "<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({
    userTemplate: {
      accessType: {
        accessType: '<string>',
        permanentAccess: {},
        temporaryAccess: {expireAt: '2021-01-01T00:00:00.000Z'}
      },
      allowedLoginMode: [],
      firstName: '<string>',
      lastName: '<string>',
      username: '<string>'
    }
  })
};

fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members', 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/teams/v2/{team_id}/members",
  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([
    'userTemplate' => [
        'accessType' => [
                'accessType' => '<string>',
                'permanentAccess' => [
                                
                ],
                'temporaryAccess' => [
                                'expireAt' => '2021-01-01T00:00:00.000Z'
                ]
        ],
        'allowedLoginMode' => [
                
        ],
        'firstName' => '<string>',
        'lastName' => '<string>',
        'username' => '<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/teams/v2/{team_id}/members"

	payload := strings.NewReader("{\n  \"userTemplate\": {\n    \"accessType\": {\n      \"accessType\": \"<string>\",\n      \"permanentAccess\": {},\n      \"temporaryAccess\": {\n        \"expireAt\": \"2021-01-01T00:00:00.000Z\"\n      }\n    },\n    \"allowedLoginMode\": [],\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"username\": \"<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/teams/v2/{team_id}/members")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userTemplate\": {\n    \"accessType\": {\n      \"accessType\": \"<string>\",\n      \"permanentAccess\": {},\n      \"temporaryAccess\": {\n        \"expireAt\": \"2021-01-01T00:00:00.000Z\"\n      }\n    },\n    \"allowedLoginMode\": [],\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members")

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  \"userTemplate\": {\n    \"accessType\": {\n      \"accessType\": \"<string>\",\n      \"permanentAccess\": {},\n      \"temporaryAccess\": {\n        \"expireAt\": \"2021-01-01T00:00:00.000Z\"\n      }\n    },\n    \"allowedLoginMode\": [],\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

Create Users

curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userTemplate": {
    "accessType": {
      "accessType": "<string>",
      "permanentAccess": {},
      "temporaryAccess": {
        "expireAt": "2021-01-01T00:00:00.000Z"
      }
    },
    "allowedLoginMode": [],
    "firstName": "<string>",
    "lastName": "<string>",
    "username": "<string>"
  }
}
'

import requests

url = "https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members"

payload = { "userTemplate": {
        "accessType": {
            "accessType": "<string>",
            "permanentAccess": {},
            "temporaryAccess": { "expireAt": "2021-01-01T00:00:00.000Z" }
        },
        "allowedLoginMode": [],
        "firstName": "<string>",
        "lastName": "<string>",
        "username": "<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({
    userTemplate: {
      accessType: {
        accessType: '<string>',
        permanentAccess: {},
        temporaryAccess: {expireAt: '2021-01-01T00:00:00.000Z'}
      },
      allowedLoginMode: [],
      firstName: '<string>',
      lastName: '<string>',
      username: '<string>'
    }
  })
};

fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members', 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/teams/v2/{team_id}/members",
  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([
    'userTemplate' => [
        'accessType' => [
                'accessType' => '<string>',
                'permanentAccess' => [
                                
                ],
                'temporaryAccess' => [
                                'expireAt' => '2021-01-01T00:00:00.000Z'
                ]
        ],
        'allowedLoginMode' => [
                
        ],
        'firstName' => '<string>',
        'lastName' => '<string>',
        'username' => '<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/teams/v2/{team_id}/members"

	payload := strings.NewReader("{\n  \"userTemplate\": {\n    \"accessType\": {\n      \"accessType\": \"<string>\",\n      \"permanentAccess\": {},\n      \"temporaryAccess\": {\n        \"expireAt\": \"2021-01-01T00:00:00.000Z\"\n      }\n    },\n    \"allowedLoginMode\": [],\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"username\": \"<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/teams/v2/{team_id}/members")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userTemplate\": {\n    \"accessType\": {\n      \"accessType\": \"<string>\",\n      \"permanentAccess\": {},\n      \"temporaryAccess\": {\n        \"expireAt\": \"2021-01-01T00:00:00.000Z\"\n      }\n    },\n    \"allowedLoginMode\": [],\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/teams/v2/{team_id}/members")

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  \"userTemplate\": {\n    \"accessType\": {\n      \"accessType\": \"<string>\",\n      \"permanentAccess\": {},\n      \"temporaryAccess\": {\n        \"expireAt\": \"2021-01-01T00:00:00.000Z\"\n      }\n    },\n    \"allowedLoginMode\": [],\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

{
  "code": 349,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

API key authentication

Path Parameters

team_id

integer<int64>

required

Team ID where the users will be created

Required range: x >= 0

Body

application/json

onboardingMode

enum<string>

Onboarding mode determines whether the user receives an invite link or is created without one

Available options:

ONBOARDING_MODE_UNSPECIFIED,

ONBOARDING_MODE_INVITE_LINK,

ONBOARDING_MODE_NO_INVITE

userTemplate

UserTemplate · object

Template containing all user properties to set during creation

Show child attributes

Response

Empty response indicating successful processing of all user creation and invitation requests. Ensure failures are returned via gRPC status codes.