ApiKey
A credential of one Organization for one environment. Vocal stores only a salt and a hash of the secret.
An object with 12 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_at | Timestamp | yes | |
created_by | ActorRef or null | no | Who made the key (1.52.0): {type: member, id} for a key created through POST /v1/api-keys, {type: operator, id} for one the seed or an operator command made when the api records it, and null when it does not. Absent from an api before 1.52.0. A removed Member keeps its id here; the keys it made stay. |
environment | Environment | yes | |
expires_at | Timestamp or null | yes | |
id | ApiKeyId | yes | |
last_used_at | Timestamp or null | yes | |
name | string | yes | |
object | "api_key" | yes | |
prefix | string | yes | The non-secret start of the key, vk_<env>_<lookup>; the full key is vk_<env>_<lookup>_<secret>. |
revoked_at | Timestamp or null | yes | |
scopes | array of ApiKeyScope | yes | |
status | ApiKeyStatus | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.