ApiKeyInfo

  • createdAt
    Type: stringFormat: date-time

    When the key was created

  • enabled
    Type: boolean

    Whether the key is enabled (false = suspended)

  • entityId
    Type: stringFormat: uuid

    Entity scope for the key

  • expiresAt
    Type: stringFormat: date-time nullable

    When the key expires (null = never)

  • id
    Type: string

    Unique API key identifier

  • isInherited
    Type: boolean

    Whether this key inherits the user's roles (roleId is null)

  • lastUsedAt
    Type: stringFormat: date-time nullable

    When the key was last used

  • name
    Type: string

    Display name for the API key

  • prefix
    Type: string

    Key prefix (e.g., "gpcn_")

  • rateLimitEnabled
    Type: boolean

    Whether rate limiting is enabled

  • rateLimitMax
    Type: integer nullable

    Maximum requests per window

  • rateLimitWindow
    Type: integer nullable

    Rate limit window in seconds

  • roleId
    Type: stringFormat: uuid nullable

    Role assigned to key (null = inherits user roles)

  • roles
    Type: array object[] · ApiKeyRoleInfo[]

    Roles for this key - single role if scoped, user's roles if inherited

    Role information for display in API key details

    • displayName
      Type: string

      Human-readable role name (e.g., "Tenant Admin")

    • id
      Type: stringFormat: uuid

      Role ID

    • name
      Type: string

      Role name (e.g., "tenant-admin")

    • sortOrder
      Type: integer

      Role privilege level (lower = higher privilege)

  • start
    Type: string

    Starting characters of the key INCLUDING prefix (e.g., "gpcn_AbC12345"). Use this alone for display, do NOT concatenate with prefix.

  • userEmail
    Type: stringFormat: email

    Email of the key owner

  • userId
    Type: stringFormat: uuid

    User who owns this key

  • userName
    Type: string

    Name of the key owner