Skip to content

ApiKeyListResponse

Type: object

Properties

Property Type Required Description
object string Yes

Object type, always "list"

Example: list

data array of ApiKey Yes

Array of API key metadata objects

has_more boolean Yes

Whether there are more results beyond this page

Example: true

subscriptionDetails map of SubscriptionDetail No

Map of subscription name to its details (display name and model names) for subscriptions referenced by the returned API keys. Used by the UI to derive Inactive status (active key whose subscription is missing) and to enrich the subscription column. For MaaS admins the BFF fills this from a Kubernetes list of MaaSSubscription CRs; for non-admins it uses the caller-scoped MaaS API /subscriptions list.

Example

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "username": "string",
      "groups": ["string"],
      "creationDate": "2024-01-31T09:30:00Z",
      "expirationDate": "2024-01-31T09:30:00Z",
      "status": "active",
      "lastUsedAt": "2024-01-31T09:30:00Z",
      "subscription": "premium-team-sub"
    }
  ],
  "has_more": true,
  "subscriptionDetails": {
    "key": {
      "displayName": "Premium Team",
      "models": ["granite-3-8b-instruct", "flan-t5-small"]
    }
  }
}