ApiKeyCreatedResponseDto

Example

JSON

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

Properties

9 properties 7 required

id string Required

name string Required

description string Optional

nullable

key string Required

Plaintext API key — shown only once

key_preview string Required

access_mode enum Required

`full_access` keys bypass RBAC entirely within the Application. `scoped` keys enforce the `scopes` array. Surface this prominently in any UI that lists keys — it's the difference between a routine integration credential and an App-wide bearer token.

Enumscopedfull_access

scopes array of string Required

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.