Skip to main content

Module api_keys

Module api_keys 

Source
Available on crate feature admin only.
Expand description

API keys: retrieve / list / update.

Note: the Admin API does not expose create / delete for API keys – those live in the Console UI. Update can change the name or lifecycle status (active / inactive / archived).

Structs§

ApiKey
An API key record (the secret value itself is never returned).
ApiKeyCreator
Actor (user or service account) that created an API key.
ApiKeys
Namespace handle for API-key endpoints.
ListApiKeysParams
Filters for ApiKeys::list.
UpdateApiKeyRequest
Request body for POST /v1/organizations/api_keys/{id} (update). Both fields are optional; pass None to leave a field unchanged.

Enums§

ApiKeyStatus
Lifecycle status of an API key (response).
WriteApiKeyStatus
Subset of ApiKeyStatus valid as a write value (no expired).