Create an operator

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/operators" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operator": {
      "name": "Jane Citizen",
      "display_name": "Jane",
      "email": "jane.citizen@example.com",
      "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
      "operator_group": "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50"
    }
  }'

from exsited import build_client

client = build_client()

response = client.operators.create_settings_operator(
    {
        "operator": {
            "name": "Jane Citizen",
            "display_name": "Jane",
            "email": "jane.citizen@example.com",
            "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
            "operator_group": "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50",
        },
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.operators.createSettingsOperator({
    operator: {
        name: 'Jane Citizen',
        display_name: 'Jane',
        email: 'jane.citizen@example.com',
        role: '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
        operator_group: 'c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50',
    },
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->operators->createSettingsOperator(
    [
        'operator' => [
            'name' => 'Jane Citizen',
            'display_name' => 'Jane',
            'email' => 'jane.citizen@example.com',
            'role' => '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
            'operator_group' => 'c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.operators.operators_dto.OperatorsDto.SettingsOperator;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsOperator> response = client.operators().createSettingsOperator(
        Map.of("operator", Map.of("name", "Jane Citizen",
                        "display_name", "Jane",
                        "email", "jane.citizen@example.com",
                        "role", "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
                        "operator_group", "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Operators.CreateSettingsOperatorAsync(
    new Dictionary<string, object?>
    {
        ["operator"] = new Dictionary<string, object?>
        {
            ["name"] = "Jane Citizen",
            ["display_name"] = "Jane",
            ["email"] = "jane.citizen@example.com",
            ["role"] = "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
            ["operator_group"] = "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.operators.createSettingsOperator(
  {
    'operator': {
      'name': 'Jane Citizen',
      'display_name': 'Jane',
      'email': 'jane.citizen@example.com',
      'role': '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
      'operator_group': 'c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50',
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Operators().CreateSettingsOperator(context.Background(), map[string]any{
	"operator": map[string]any{
		"name": "Jane Citizen",
		"display_name": "Jane",
		"email": "jane.citizen@example.com",
		"role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
		"operator_group": "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "operator": {
    "object": "<string>",
    "id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "email": "<string>",
    "description": "<unknown>",
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "href": "<string>"
  }
}

POST

settings

operators

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/operators" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operator": {
      "name": "Jane Citizen",
      "display_name": "Jane",
      "email": "jane.citizen@example.com",
      "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
      "operator_group": "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50"
    }
  }'

from exsited import build_client

client = build_client()

response = client.operators.create_settings_operator(
    {
        "operator": {
            "name": "Jane Citizen",
            "display_name": "Jane",
            "email": "jane.citizen@example.com",
            "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
            "operator_group": "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50",
        },
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.operators.createSettingsOperator({
    operator: {
        name: 'Jane Citizen',
        display_name: 'Jane',
        email: 'jane.citizen@example.com',
        role: '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
        operator_group: 'c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50',
    },
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->operators->createSettingsOperator(
    [
        'operator' => [
            'name' => 'Jane Citizen',
            'display_name' => 'Jane',
            'email' => 'jane.citizen@example.com',
            'role' => '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
            'operator_group' => 'c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.operators.operators_dto.OperatorsDto.SettingsOperator;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsOperator> response = client.operators().createSettingsOperator(
        Map.of("operator", Map.of("name", "Jane Citizen",
                        "display_name", "Jane",
                        "email", "jane.citizen@example.com",
                        "role", "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
                        "operator_group", "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Operators.CreateSettingsOperatorAsync(
    new Dictionary<string, object?>
    {
        ["operator"] = new Dictionary<string, object?>
        {
            ["name"] = "Jane Citizen",
            ["display_name"] = "Jane",
            ["email"] = "jane.citizen@example.com",
            ["role"] = "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
            ["operator_group"] = "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.operators.createSettingsOperator(
  {
    'operator': {
      'name': 'Jane Citizen',
      'display_name': 'Jane',
      'email': 'jane.citizen@example.com',
      'role': '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
      'operator_group': 'c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50',
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Operators().CreateSettingsOperator(context.Background(), map[string]any{
	"operator": map[string]any{
		"name": "Jane Citizen",
		"display_name": "Jane",
		"email": "jane.citizen@example.com",
		"role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
		"operator_group": "c41e7a92-5b3d-4f08-9a6e-2d8b1f7c3e50",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "operator": {
    "object": "<string>",
    "id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "email": "<string>",
    "description": "<unknown>",
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "href": "<string>"
  }
}

role is required, and role and operator_group take dashed uuids. The new operator comes back under operator.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Body

application/json

operator

object

required

Show child attributes

Response

201 - application/json

The new operator, under operator.

operator

object

One operator.

Show child attributes

Guides

API reference

Authorizations

Body

Response