Create Internal User

Create an internal user

curl --request POST \
  --url https://your-syteca-host/SytecaACB/api/user-management/users/internal \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "admin_permissions": {
    "direct_permission_keys": [
      "<string>"
    ]
  },
  "auth_token_lifetime_sec": 123,
  "client_access_rules": [
    {
      "client_group_id": 123,
      "client_id": 123,
      "permission_keys": [
        "<string>"
      ]
    }
  ],
  "description": "<string>",
  "email": "<string>",
  "external_app_enabled": true,
  "first_name": "<string>",
  "ip_restrictions": [
    "<string>"
  ],
  "last_name": "<string>",
  "password": "<string>",
  "two_factor_required": true,
  "user_access_rules": [
    {
      "account_name": "<string>",
      "domain_or_computer": "<string>"
    }
  ],
  "user_group_ids": [
    123
  ],
  "username": "<string>"
}
'

import requests

url = "https://your-syteca-host/SytecaACB/api/user-management/users/internal"

payload = {
    "admin_permissions": { "direct_permission_keys": ["<string>"] },
    "auth_token_lifetime_sec": 123,
    "client_access_rules": [
        {
            "client_group_id": 123,
            "client_id": 123,
            "permission_keys": ["<string>"]
        }
    ],
    "description": "<string>",
    "email": "<string>",
    "external_app_enabled": True,
    "first_name": "<string>",
    "ip_restrictions": ["<string>"],
    "last_name": "<string>",
    "password": "<string>",
    "two_factor_required": True,
    "user_access_rules": [
        {
            "account_name": "<string>",
            "domain_or_computer": "<string>"
        }
    ],
    "user_group_ids": [123],
    "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({
    admin_permissions: {direct_permission_keys: ['<string>']},
    auth_token_lifetime_sec: 123,
    client_access_rules: [{client_group_id: 123, client_id: 123, permission_keys: ['<string>']}],
    description: '<string>',
    email: '<string>',
    external_app_enabled: true,
    first_name: '<string>',
    ip_restrictions: ['<string>'],
    last_name: '<string>',
    password: '<string>',
    two_factor_required: true,
    user_access_rules: [{account_name: '<string>', domain_or_computer: '<string>'}],
    user_group_ids: [123],
    username: '<string>'
  })
};

fetch('https://your-syteca-host/SytecaACB/api/user-management/users/internal', 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://your-syteca-host/SytecaACB/api/user-management/users/internal",
  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([
    'admin_permissions' => [
        'direct_permission_keys' => [
                '<string>'
        ]
    ],
    'auth_token_lifetime_sec' => 123,
    'client_access_rules' => [
        [
                'client_group_id' => 123,
                'client_id' => 123,
                'permission_keys' => [
                                '<string>'
                ]
        ]
    ],
    'description' => '<string>',
    'email' => '<string>',
    'external_app_enabled' => true,
    'first_name' => '<string>',
    'ip_restrictions' => [
        '<string>'
    ],
    'last_name' => '<string>',
    'password' => '<string>',
    'two_factor_required' => true,
    'user_access_rules' => [
        [
                'account_name' => '<string>',
                'domain_or_computer' => '<string>'
        ]
    ],
    'user_group_ids' => [
        123
    ],
    '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://your-syteca-host/SytecaACB/api/user-management/users/internal"

	payload := strings.NewReader("{\n  \"admin_permissions\": {\n    \"direct_permission_keys\": [\n      \"<string>\"\n    ]\n  },\n  \"auth_token_lifetime_sec\": 123,\n  \"client_access_rules\": [\n    {\n      \"client_group_id\": 123,\n      \"client_id\": 123,\n      \"permission_keys\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"email\": \"<string>\",\n  \"external_app_enabled\": true,\n  \"first_name\": \"<string>\",\n  \"ip_restrictions\": [\n    \"<string>\"\n  ],\n  \"last_name\": \"<string>\",\n  \"password\": \"<string>\",\n  \"two_factor_required\": true,\n  \"user_access_rules\": [\n    {\n      \"account_name\": \"<string>\",\n      \"domain_or_computer\": \"<string>\"\n    }\n  ],\n  \"user_group_ids\": [\n    123\n  ],\n  \"username\": \"<string>\"\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://your-syteca-host/SytecaACB/api/user-management/users/internal")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"admin_permissions\": {\n    \"direct_permission_keys\": [\n      \"<string>\"\n    ]\n  },\n  \"auth_token_lifetime_sec\": 123,\n  \"client_access_rules\": [\n    {\n      \"client_group_id\": 123,\n      \"client_id\": 123,\n      \"permission_keys\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"email\": \"<string>\",\n  \"external_app_enabled\": true,\n  \"first_name\": \"<string>\",\n  \"ip_restrictions\": [\n    \"<string>\"\n  ],\n  \"last_name\": \"<string>\",\n  \"password\": \"<string>\",\n  \"two_factor_required\": true,\n  \"user_access_rules\": [\n    {\n      \"account_name\": \"<string>\",\n      \"domain_or_computer\": \"<string>\"\n    }\n  ],\n  \"user_group_ids\": [\n    123\n  ],\n  \"username\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-syteca-host/SytecaACB/api/user-management/users/internal")

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  \"admin_permissions\": {\n    \"direct_permission_keys\": [\n      \"<string>\"\n    ]\n  },\n  \"auth_token_lifetime_sec\": 123,\n  \"client_access_rules\": [\n    {\n      \"client_group_id\": 123,\n      \"client_id\": 123,\n      \"permission_keys\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"email\": \"<string>\",\n  \"external_app_enabled\": true,\n  \"first_name\": \"<string>\",\n  \"ip_restrictions\": [\n    \"<string>\"\n  ],\n  \"last_name\": \"<string>\",\n  \"password\": \"<string>\",\n  \"two_factor_required\": true,\n  \"user_access_rules\": [\n    {\n      \"account_name\": \"<string>\",\n      \"domain_or_computer\": \"<string>\"\n    }\n  ],\n  \"user_group_ids\": [\n    123\n  ],\n  \"username\": \"<string>\"\n}"

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

{
  "id": 123,
  "user_type": "<string>",
  "username": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "description": "<string>",
  "two_factor_required": true,
  "external_app_enabled": true,
  "auth_token_lifetime_sec": 123,
  "ip_restrictions": [
    "<string>"
  ],
  "user_group_ids": [
    123
  ],
  "has_user_groups": true
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

POST

api

user-management

users

internal

Create an internal user

curl --request POST \
  --url https://your-syteca-host/SytecaACB/api/user-management/users/internal \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "admin_permissions": {
    "direct_permission_keys": [
      "<string>"
    ]
  },
  "auth_token_lifetime_sec": 123,
  "client_access_rules": [
    {
      "client_group_id": 123,
      "client_id": 123,
      "permission_keys": [
        "<string>"
      ]
    }
  ],
  "description": "<string>",
  "email": "<string>",
  "external_app_enabled": true,
  "first_name": "<string>",
  "ip_restrictions": [
    "<string>"
  ],
  "last_name": "<string>",
  "password": "<string>",
  "two_factor_required": true,
  "user_access_rules": [
    {
      "account_name": "<string>",
      "domain_or_computer": "<string>"
    }
  ],
  "user_group_ids": [
    123
  ],
  "username": "<string>"
}
'

import requests

url = "https://your-syteca-host/SytecaACB/api/user-management/users/internal"

payload = {
    "admin_permissions": { "direct_permission_keys": ["<string>"] },
    "auth_token_lifetime_sec": 123,
    "client_access_rules": [
        {
            "client_group_id": 123,
            "client_id": 123,
            "permission_keys": ["<string>"]
        }
    ],
    "description": "<string>",
    "email": "<string>",
    "external_app_enabled": True,
    "first_name": "<string>",
    "ip_restrictions": ["<string>"],
    "last_name": "<string>",
    "password": "<string>",
    "two_factor_required": True,
    "user_access_rules": [
        {
            "account_name": "<string>",
            "domain_or_computer": "<string>"
        }
    ],
    "user_group_ids": [123],
    "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({
    admin_permissions: {direct_permission_keys: ['<string>']},
    auth_token_lifetime_sec: 123,
    client_access_rules: [{client_group_id: 123, client_id: 123, permission_keys: ['<string>']}],
    description: '<string>',
    email: '<string>',
    external_app_enabled: true,
    first_name: '<string>',
    ip_restrictions: ['<string>'],
    last_name: '<string>',
    password: '<string>',
    two_factor_required: true,
    user_access_rules: [{account_name: '<string>', domain_or_computer: '<string>'}],
    user_group_ids: [123],
    username: '<string>'
  })
};

fetch('https://your-syteca-host/SytecaACB/api/user-management/users/internal', 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://your-syteca-host/SytecaACB/api/user-management/users/internal",
  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([
    'admin_permissions' => [
        'direct_permission_keys' => [
                '<string>'
        ]
    ],
    'auth_token_lifetime_sec' => 123,
    'client_access_rules' => [
        [
                'client_group_id' => 123,
                'client_id' => 123,
                'permission_keys' => [
                                '<string>'
                ]
        ]
    ],
    'description' => '<string>',
    'email' => '<string>',
    'external_app_enabled' => true,
    'first_name' => '<string>',
    'ip_restrictions' => [
        '<string>'
    ],
    'last_name' => '<string>',
    'password' => '<string>',
    'two_factor_required' => true,
    'user_access_rules' => [
        [
                'account_name' => '<string>',
                'domain_or_computer' => '<string>'
        ]
    ],
    'user_group_ids' => [
        123
    ],
    '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://your-syteca-host/SytecaACB/api/user-management/users/internal"

	payload := strings.NewReader("{\n  \"admin_permissions\": {\n    \"direct_permission_keys\": [\n      \"<string>\"\n    ]\n  },\n  \"auth_token_lifetime_sec\": 123,\n  \"client_access_rules\": [\n    {\n      \"client_group_id\": 123,\n      \"client_id\": 123,\n      \"permission_keys\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"email\": \"<string>\",\n  \"external_app_enabled\": true,\n  \"first_name\": \"<string>\",\n  \"ip_restrictions\": [\n    \"<string>\"\n  ],\n  \"last_name\": \"<string>\",\n  \"password\": \"<string>\",\n  \"two_factor_required\": true,\n  \"user_access_rules\": [\n    {\n      \"account_name\": \"<string>\",\n      \"domain_or_computer\": \"<string>\"\n    }\n  ],\n  \"user_group_ids\": [\n    123\n  ],\n  \"username\": \"<string>\"\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://your-syteca-host/SytecaACB/api/user-management/users/internal")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"admin_permissions\": {\n    \"direct_permission_keys\": [\n      \"<string>\"\n    ]\n  },\n  \"auth_token_lifetime_sec\": 123,\n  \"client_access_rules\": [\n    {\n      \"client_group_id\": 123,\n      \"client_id\": 123,\n      \"permission_keys\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"email\": \"<string>\",\n  \"external_app_enabled\": true,\n  \"first_name\": \"<string>\",\n  \"ip_restrictions\": [\n    \"<string>\"\n  ],\n  \"last_name\": \"<string>\",\n  \"password\": \"<string>\",\n  \"two_factor_required\": true,\n  \"user_access_rules\": [\n    {\n      \"account_name\": \"<string>\",\n      \"domain_or_computer\": \"<string>\"\n    }\n  ],\n  \"user_group_ids\": [\n    123\n  ],\n  \"username\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-syteca-host/SytecaACB/api/user-management/users/internal")

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  \"admin_permissions\": {\n    \"direct_permission_keys\": [\n      \"<string>\"\n    ]\n  },\n  \"auth_token_lifetime_sec\": 123,\n  \"client_access_rules\": [\n    {\n      \"client_group_id\": 123,\n      \"client_id\": 123,\n      \"permission_keys\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"email\": \"<string>\",\n  \"external_app_enabled\": true,\n  \"first_name\": \"<string>\",\n  \"ip_restrictions\": [\n    \"<string>\"\n  ],\n  \"last_name\": \"<string>\",\n  \"password\": \"<string>\",\n  \"two_factor_required\": true,\n  \"user_access_rules\": [\n    {\n      \"account_name\": \"<string>\",\n      \"domain_or_computer\": \"<string>\"\n    }\n  ],\n  \"user_group_ids\": [\n    123\n  ],\n  \"username\": \"<string>\"\n}"

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

{
  "id": 123,
  "user_type": "<string>",
  "username": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "description": "<string>",
  "two_factor_required": true,
  "external_app_enabled": true,
  "auth_token_lifetime_sec": 123,
  "ip_restrictions": [
    "<string>"
  ],
  "user_group_ids": [
    123
  ],
  "has_user_groups": true
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

Creates a new Syteca Internal user — managed entirely within Syteca, with credentials and password lifecycle stored in the Syteca database. Use this when you want full programmatic control over the user (vs linking an Active Directory account via Create domain user).

For ACB deployments updated from a version prior to 1.2, switch to the https://{hostname}/EkranACB server in the Playground.

Permissions required

The Access Token must be issued to a user with the administrative User Management permission.

Common use cases

IdP-driven provisioning — Okta / Azure AD / Workday triggers user creation in Syteca via webhook + this endpoint.
Service desk automation — ticket-driven user onboarding writes directly to Syteca rather than going through manual admin steps.
Contractor onboarding — short-lived accounts created programmatically with auto-cleanup via Delete user after engagement end.

Errors

See Status codes. Common errors:

400 Bad Request — invalid field values (login format, password policy violation).
403 Forbidden — user lacks administrative User Management permission.
409 Conflict — login already exists.

Create domain user

Link an Active Directory user instead.

Get user details

Verify creation succeeded.

Update admin permissions

Grant admin permissions after creation.

Add to user group

Assign group membership.

Authorizations

Authorization

string

header

required

Access token for authentication

Body

application/json

admin_permissions

object

List of administrative permissions to assign directly to the user

Show child attributes

auth_token_lifetime_sec

integer<int32> | null

The lifetime of an access token in seconds for this user

client_access_rules

object[] | null

List of direct Client Access rules for this user

Show child attributes

description

string | null

Free-form comment/description for the user

string | null

User’s email address

external_app_enabled

boolean

Allow this user account to be used by external applications

first_name

string | null

User’s first name (display only)

ip_restrictions

string[] | null

Allowed IP address for this user’s API access

IP address

last_name

string | null

User’s last name (display only)

password

string | null

User password that satisfies the current password policy

two_factor_required

boolean

Enable two-factor authentication on login

user_access_rules

object[] | null

Direct User Access rules for the user

Show child attributes

user_group_ids

integer<int32>[] | null

IDs of Syteca user groups, the internal user should be added

Syteca user group ID

username

string | null

Response

User created successfully

integer<int32>

Unique Syteca user ID

user_type

string | null

User type

username

string | null

first_name

string | null

First name

last_name

string | null

Last name

string | null

Email address

description

string | null

Optional description/comment

two_factor_required

boolean

Two-factor authentication on login

external_app_enabled

boolean

Allow this user account to be used by external applications

auth_token_lifetime_sec

integer<int32> | null

The lifetime of an access token in seconds for this user

ip_restrictions

string[] | null

Allowed IP address for this user's API access

IP address

user_group_ids

integer<int32>[] | null

List of Syteca user group IDs this user belongs to

Syteca user group ID

has_user_groups

boolean

The user is a member of any user groups

Overview

Application Credentials Broker

Data Connector API

SSO & LDAP

SIEM & Ticketing systems

Create Internal User

Permissions required

Common use cases

Errors

Create domain user

Get user details

Update admin permissions

Add to user group

Authorizations

Body

Response

​Permissions required

​Common use cases

​Errors

​Related

Create domain user

Get user details

Update admin permissions

Add to user group

Authorizations

Body

Response

Permissions required

Common use cases

Errors

Related