API keys (recommended for services)
Create a key under Settings → API keys, or Access management → Keys for administrators. See API keys. Send it in theX-API-Key header on every request:
Login tokens (interactive sessions)
For short-lived programmatic sessions, exchange an email and password for a JWT:access_token. Send it as
Authorization: Bearer <access_token> on subsequent requests. Tokens expire after the configured TTL; refresh by logging
in again.
GET /api/auth/me returns the current user profile and roles.
API key scopes
Every key carries a list of scopes. On each request the platform derives the scope that route requires and checks the key against it, so a key can only reach the surfaces it was issued for.The scope list
* used to expand to the Data Security scopes alone, so a key
labelled Full access carried no Runtime Security authority and
could not call the firewall. It now covers both halves of the
platform. If you worked around this by minting a second
runtime:* key, you no longer need it, though the extra key keeps
working.runtime:* (datasets:*, for example) are not valid scopes and are
never recognised, at creation or on a request.
Which scope a route requires
The required scope is derived from the path and the method. Reads areGET, HEAD, and OPTIONS; everything else counts as a write.
The
/results row is matched first, so a results path wins over the
scans or datasets rows it might otherwise fall into.
A key can never exceed its creator
Each scope is backed by a permission the creating user must hold, so minting a key is never a way to gain access:runtime:* is granted only when the creator can exercise all four
runtime: scopes, and * only when they can exercise every scope in
the table. Asking for a scope you do not hold returns 403.
Creating a key
GET /api/api-keys/scopes returns the scope list with labels, which
is what the console renders.

