Overview

Accounts allow users to authenticate with the Enterprise API using email and password credentials.

Key Concepts

Account Creation

Accounts can be created in two ways:

MethodEndpointAccess
Protected Route/v1/admin/account/registerRequires Super Admin or admin credentials
Self-Registration/v1/account/registerPublic (controlled by feature flag)
  • A Super Admin (or any admin with the right permissions) typically creates accounts via the protected administration route.
  • Optional self-service signup is available via an unprotected endpoint that is controlled by the account-registration feature flag. The flag defaults to enabled, so public signup is exposed unless you disable it.

Initial State

  • New accounts start without any roles, so they cannot perform any operations until roles are assigned.
  • Accounts must be assigned roles to gain access to resources.

Account Scope

Accounts are global resources and are not bound to a single organization or tenant:

  • The same account can be granted access to multiple organizations, tenants, sub-tenants, or services
  • What an account can do is entirely determined by the roles assigned to it
  • Permissions are evaluated based on the combination of all assigned roles

Self-Registration

The unprotected /v1/account/register endpoint is controlled by the account-registration feature flag:

Flag StateBehavior
Enabled (default)Public signup is available
DisabledOnly protected admin route works

Recommendation: Disable this flag in production environments to prevent unauthorized account creation. Only leave it enabled for sandboxes, demos, or controlled environments.

Toggle the feature via the feature manager or _features.conf, depending on your deployment workflow.

Account vs API Key

FeatureAccountAPI Key
AuthenticationEmail + passwordBearer token
Use caseHuman usersMachine-to-machine
Session managementYes (with session tokens)Stateless
Self-registrationOptional (feature flag)No (admin only)
ExpirationNo (unless manually disabled)Optional TTL

Get Started

  • Create Account - Provision an account via the protected admin APIs (or optional self-registration)
  • Assign Roles - Give an account permissions scoped to specific organizations, tenants, or services
Last updated on May 6, 2026