Skip to main content
POST
Add a domain user
Links an existing Active Directory user to Syteca. The user account itself stays in AD — Syteca just creates a reference to it for permission assignment, monitoring scope, and access control. AD remains the source of truth for the user’s credentials and identity attributes.
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.

Prerequisites

  • The AD user must already exist in a domain reachable by the Syteca Application Server.
  • The domain must be configured in Syteca — see LDAP/AD integration.

Common use cases

  • AD-driven onboarding — Group membership changes in AD (e.g. user added to a “PrivilegedAdmins” group) trigger this endpoint to register the user in Syteca.
  • AD group sync — Syncing Syteca user groups against AD group memberships nightly.
  • Compliance audit prep — Bulk-link all AD users in a privileged role group to Syteca before an audit window.

Errors

See Status codes. Common errors:
  • 400 Bad Request — invalid user identifier or missing required fields.
  • 403 Forbidden — user lacks administrative User Management permission.
  • 409 Conflict — AD user is already linked to Syteca.
  • 422 Unprocessable Entity — the AD domain referenced isn’t configured in Syteca.

Create internal user

Create a Syteca-managed user instead.

Get user details

Verify the link.

Update admin permissions

Grant admin permissions after creation.

Update client access

Set which Clients the user can see.

Authorizations

Authorization
string
header
required

Access token for authentication

Body

application/json
account_name
string | null

AD user name

auth_token_lifetime_sec
integer<int32> | null

The lifetime of an access token in seconds for this user

domain
string | null

AD domain name

external_app_enabled
boolean

Allow this user account to be used by external applications

ip_restrictions
string[] | null

Allowed IP address for this user's API access

IP address

two_factor_required
boolean

Enable two-factor authentication on login

user_group_ids
integer<int32>[] | null

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

Syteca user group ID

Response

Domain user added successfully

id
integer<int32>

Unique Syteca user ID

user_type
string | null

User type

account_name
string | null

Domain account name

domain
string | null

AD domain name

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