Update an API key
Updates an API key, including its workspace assignments.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The API key to update. Accepts the canonical apikey_… form or the external_id:<value> form.
"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"
Body
UpdateAccountResourceMetadata contains the user-provided fields for updating an account-scoped resource. Read-only fields (id, account_id, profile_id) are excluded since they are set by the server.
Configuration for an API key.
Fields to update. Selecting spec.workspace_assignments replaces the whole set; selecting spec.all_workspaces turns the all-workspaces grant on or off. Turning it off keeps the workspaces the key currently reaches.
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