ApiKey¶

Type: object

Properties¶

Property	Type	Required	Description
`id`	string	Yes	Unique identifier for the API key
`name`	string	Yes	User-friendly name for the API key
`description`	string	No	Optional description providing context about the key's purpose
`username`	string	No	Username that owns this API key
`groups`	array of string	No	User's groups at creation time (immutable snapshot for authorization)
`creationDate`	string (date-time)	Yes	When the API key was created
`expirationDate`	string (date-time)	No	When the API key expires (empty for permanent keys)
`status`	string	Yes	Current status of the API key Allowed values: `active`, `revoked`, `expired`
`lastUsedAt`	string (date-time)	No	When the API key was last used for validation
`subscription`	string	No	Name of the subscription associated with this API key Example: `premium-team-sub`

Example¶

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