Admiral

Access

Authentication

Sign in to Admiral in the console or the CLI, and use a personal API key, bounded by scopes, for scripts and CI.

Admiral is hosted, so authentication has two sides: how people sign in through the console or the CLI, and how machines (CI and automation) authenticate to the API. This page explains both. There is no identity provider for you to install or configure, because that is part of the managed service.

Signing in

You sign in to the console through your identity, and the CLI signs in the same way:

admiral auth login

admiral auth login opens a browser to complete sign-in, then stores a session so subsequent commands are authenticated. Your session is maintained by Admiral Cloud with configurable idle and absolute lifetimes.

Token types

For anything non-interactive, such as a script or a CI pipeline, you use a personal API key:

  • It belongs to you, and acts with your permissions, limited to the scopes you chose when you created it.
  • You create it in the console, or with the CLI:
admiral apikey create ci-deploy --scope changeset:write,run:write
  • Admiral shows the key once, when you create it. Store it in your CI system's secret store and expose it as ADMIRAL_API_KEY, as CLI authentication shows.
  • It stops working when you leave the organization or revoke it.

Signing in from CI as a service account, a non-human identity that outlives any one person, is not available yet. Until it is, give CI a personal key with only the scopes the pipeline needs.

An agent does not use an API key. Admiral trusts its cluster instead, see Agents.

Scopes

API keys carry scopes that bound what they can do (for example, catalog:read versus catalog:write). Grant the narrowest scope that fits the job, especially for a key that lives in CI. A personal key for Terraform is limited to the Terraform API, which serves hosted state.

Rotating and revoking

Treat an API key like any other secret. Rotate a key that lives in CI on a schedule, and revoke any key that may be exposed. A revoked key stops authenticating within 5 minutes.

Where to go next

On this page