APIKeyResponseV5

Response body for v5 API key endpoints. The plaintext key is populated on the create (POST) response, for legacy keys, and for bring-your-own keys created with always_retrievable; on later reads of any other key it is null and only key_last4 is returned.

  • account_id
    Type: string
    required
  • created_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • id
    Type: string
    required
  • is_legacy
    Type: boolean
    required
  • name
    Type: string
    required
  • permissions
    Type: array of Permissionenum
    required
  • status
    Type: enum
    required
    values
    activerevokedexpired
  • always_retrievable
    Type: boolean

    True when this key was created as a bring-your-own key with always_retrievable, meaning key stays populated on every read.

  • expires_at
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • key
    Type: stringnullable

    Plaintext key. Populated on the create (POST) response, for legacy keys, and for bring-your-own keys created with always_retrievable; null on later reads of any other key.

  • key_last4
    Type: stringnullable

    Last four characters of the secret, for display.

  • last_used_at
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z