Admin

Create Api Key

Changed on

Create an API key for a user (admin only).

The raw key is returned only in this response and cannot be retrieved again. Requires a signed-in session: a request that presents an API key gets 403.

post/admin/api-keys/

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/auth/login)

Request body

user_idstring uuid required

ID of the user the new API key will belong to.

namestring required

Human-readable label for the API key (e.g. 'CI pipeline', 'QGIS desktop').

expires_atstring date-time nullable

Optional expiry timestamp (RFC 3339, timezone-aware). Omit or null for a non-expiring key; expired keys stop authenticating.

scope'full' | 'read_only'

Privilege scope. 'full' impersonates the owner completely. 'read_only' authenticates GET, HEAD and OPTIONS requests only; any other method is refused with 403. A service-account key minted for an application is the usual case for 'read_only'.

Response

Successful Response

idstring uuid required
keystring required

The API key secret (shown only once)

fingerprintstring required

Non-secret key identifier (prefix and last four characters)

namestring required
expires_atstring date-time nullable

Expiry timestamp; null means the key does not expire

scopestring required

Privilege scope: 'full' or 'read_only'

created_atstring date-time required

Changes

  • d3763169bba2Revision changes
    • info

      the endpoint scheme security ApiKeyHeader was removed from the API

    • info

      the endpoint scheme security ApiKeyQuery was removed from the API