List customer API keys
Lists the signed-in account's active API keys, oldest first. Revoked keys are not returned. Each entry carries masked rather than the secret, which is shown only once by POST /api-keys.
Session credential only; an API key or a legacy Auth0 token answers 403 session_required.
List customer API keys › Responses
The account's active API keys.
Active keys, oldest first.
Create a customer API key
Creates an API key for the signed-in account and returns its plaintext secret once. Only the SHA-256 hash of the secret is stored: neither this endpoint nor GET /api-keys ever returns it again, and later reads carry masked instead.
Session credential only. An API key or a legacy Auth0 token in the Authorization header answers 403 session_required and nothing is created. An account may hold at most 50 active keys; the 51st answers 409 api_key_limit_reached until one is revoked.
Create a customer API key › Request Body
nameLabel for the key, at most 255 characters after trimming whitespace. Shown in GET /api-keys.
Create a customer API key › Responses
The key was created. The body carries the one-time plaintext secret, so the response is marked no-store.
idKey id, used by DELETE /api-keys/{id}.
namecreated_atmaskedDisplay form of the key, ffk_•••• plus the last four id characters. Safe to show.
secretThe plaintext API key, sent as Authorization: Bearer <secret>. Returned once, only here; only its SHA-256 hash is stored.
Revoke a customer API key
Revokes one of the signed-in account's API keys by id. Revocation is permanent and takes effect immediately: the key stops resolving even if a replica cached it. Revoking an already revoked key answers 404.
Session credential only; an API key or a legacy Auth0 token answers 403 session_required.
path Parameters
idAPI key id, as returned by POST /api-keys and GET /api-keys.
Revoke a customer API key › Responses
The key is revoked.