AdminApiKeyResponseDto

  • businessId
    Type: number
    required
  • createdAt
    Type: string Format: date-time
    required

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

  • environment
    Type: string enum
    required
    values
    • LIVE
    • TEST
  • id
    Type: number
    required
  • keyPrefix
    Type: string
    required

    First 14 characters of the key for identification

  • name
    Type: string
    required
  • status
    Type: string enum
    required
    values
    • ACTIVE
    • REVOKED
    • EXPIRED
  • business
    Type: object ยท AdminApiKeyBusinessDto
    • id
      Type: number
      required
    • email
      Type: string
    • firstName
      Type: string
    • lastName
      Type: string
    • username
      Type: string
  • createdBy
    Type: string
  • expiresAt
    Type: string Format: date-time

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

  • ipWhitelist
    Type: array string[]
  • lastUsedAt
    Type: string Format: date-time

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

  • revokedAt
    Type: string Format: date-time

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

  • revokedReason
    Type: string