Disable an API key
Disables an API key. While disabled, presenting the key’s token fails authentication on every endpoint; the key is retained. Idempotent.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The API key to disable. Accepts the canonical apikey_… form or the external_id:<value> form.
"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"
Body
The body is of type object.
Response
OK
An API key. Keys belong to the account and are managed by account administrators. A key reaches the workspaces it is assigned to, or every workspace (present and future) when all_workspaces is set. Its scopes are the same in every workspace it reaches.
AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.
Configuration for an API key.
The current lifecycle state of the API key. Output only. Keys are created STATE_ENABLED; use the :disable and :enable actions to transition between states.
STATE_UNSPECIFIED, STATE_ENABLED, STATE_DISABLED