Before You Begin

Authentication Flow

Most API calls require a bearer token. First, call the login endpoint, then use the returned JWT token in subsequent API requests.

POST https://<url>/admin/api/auth/login
Content-Type: application/json

{
  "email": "admin@example.com",
  "password": "********",
  "oa": false
}

Authorization: Bearer <JWT_TOKEN>

API Categories

Endpoint Catalog

The following table lists the available operations by API group. Replace <url>, <port>, and path parameters such as :id with values from your environment.

Agents

Manage directory/SQL agents, replicas, and installation packages.

Apps

Create and configure applications, app parameters, desktop SSO, directories, members, agents, and database mapping.

Audit

Query, read, and download audit events from the audit index.

Authentication

Login, logout, portal login, and JWT token refresh endpoints.

Authenticators

Manage authenticator templates, types, states, and assigned authenticators.

Directories

Manage directory connections, groups, members, policies, domains, services, license assignments, and users.

Groups

Manage groups, group members, and related applications.

Portals

Configure end-user/admin portal settings, theme, and desktop/mobile app behavior.

Publications

Read and publish configuration changes across the environment.

Replicas

Manage replicas and replica lifecycle actions.

Reports

Create, update, export, and manage report definitions.

SIEMs

Configure SIEM integrations and SIEM connection settings.

Services

Manage service templates, domains, agents, directories, members, parameters, accounts, and config.

Settings

Manage system-level settings including license, password policy, providers, connectors, SMS, SMTP, QR, and additional platform settings.

Users

Manage users, authenticators, groups, apps, tokens, invitation, enrollment, reactivation, block/unblock, and related user operations.

Workstations

Manage workstation records, reset flows, user lists, history, and FileVault password reset.