1. Docs
  2. API Reference
  3. ApiKeyResponseDto

The ApiKeyResponseDto object

Example

{
  "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

  • idstring*
  • client_idstring*
  • namestring*
  • descriptionstring
  • key_previewstring*

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

  • access_modeenum: "scoped" | "full_access"*

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

  • scopesstring[]*
  • is_activeboolean*
  • last_used_atstring (date-time)
  • expires_atstring (date-time)
  • created_atstring (date-time)*