Back to docs

Management API reference

Your server, CI or Terraform provisions tenants, apps, custom domains, sender addresses, social logins, resource servers, organizations and theming across an account with a secret credential, an account API key. Not sure this is the right API? See Choosing an API.

Authentication

Send an account API key as Authorization: Bearer …. Each operation needs one of these scopes:

  • account:read: Read the account the key belongs to
  • tenants:read: Read tenants and their allowed origins
  • tenants:write: Create, update, and delete tenants, and add and remove their allowed origins
  • apps:read: Read apps
  • apps:write: Create, update, and delete apps
  • domains:read: Read custom domains
  • domains:write: Create, verify, and delete custom domains
  • sender-addresses:read: Read sender addresses, and the address a tenant sends from
  • sender-addresses:write: Add, verify, and remove sender addresses, and choose the address a tenant sends from
  • social-logins:read: Read social login providers
  • social-logins:write: Create, update, and delete social login providers
  • resource-servers:read: Read resource servers and their scopes
  • resource-servers:write: Create, update, and delete resource servers and their scopes
  • organizations:read: Read organizations and their members
  • organizations:write: Create, update, and delete organizations and their email domains
  • organization-members:write: Add and remove an organization's members
  • portal-links:write: Create and revoke an organization's setup link
  • theme:read: Read the login page theme
  • theme:write: Update the login page theme

Errors share one JSON shape with a stable error code. Every code and its fix is listed in Errors.

OpenAPI spec

Download the spec as JSON or YAML, or read this page as markdown. The reference below is rendered from the same spec, and the API is tested against it. Point your client generator, editor or agent at https://api.authalla.com/management/v1/openapi.json.

To try requests, import that URL into Postman (Import → Link), Bruno (Import Collection → OpenAPI V3 Spec) or Insomnia (Import → URL), then set the bearer token on the collection.