The ApiKeyCreatedResponseDto object

Example

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

idstring*
namestring*
descriptionstring
keystring*
Plaintext API key — shown only once
key_previewstring*
access_modeenum: "scoped" | "full_access"*
`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.
scopesstring[]*
expires_atstring (date-time)
created_atstring (date-time)*