ApiKeyResponseDto

Example

JSON

{
  "id": "string",
  "client_id": "string",
  "name": "string",
  "description": "string",
  "key_preview": "string",
  "access_mode": "scoped",
  "scopes": [
    "string"
  ],
  "is_active": false,
  "last_used_at": "2026-04-20T12:00:00.000Z",
  "expires_at": "2026-04-20T12:00:00.000Z",
  "created_at": "2026-04-20T12:00:00.000Z"
}

Properties

11 properties 8 required

id string Required

client_id string Required

name string Required

description string Optional

nullable

key_preview string Required

Masked preview of the raw key (first 12 chars + `****`).

access_mode enum Required

`full_access` keys bypass RBAC entirely within the Application. `scoped` keys enforce the `scopes` array.

Enumscopedfull_access

scopes array of string Required

is_active boolean Required

last_used_at string Optional

format: date-timenullable

expires_at string Optional

format: date-timenullable

created_at string Required

format: date-time

Was this page helpful?

Tell us how we can improve this guide.