Sign in

v172

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0826148911.7 MB
Management keys

Update a management key

Updates mutable fields of a management key: display name, status (active / disabled / revoked), permission mode and access map, and expiry. Omitted fields keep their current values.

patch/v2/management-keys/{management_key_id}

Path parameters

management_key_idstring required

Management key id to update.

Request body

namestring

New name. Omit to keep current.

status'MANAGEMENT_KEY_STATUS_UNSPECIFIED' | 'MANAGEMENT_KEY_STATUS_ACTIVE' | 'MANAGEMENT_KEY_STATUS_DISABLED' | 'MANAGEMENT_KEY_STATUS_REVOKED'
permission_mode'MANAGEMENT_PERMISSION_MODE_UNSPECIFIED' | 'MANAGEMENT_PERMISSION_MODE_ALL' | 'MANAGEMENT_PERMISSION_MODE_RESTRICTED' | 'MANAGEMENT_PERMISSION_MODE_READ_ONLY'
accessobject

Replacement access map. Required when changing to MANAGEMENT_PERMISSION_MODE_RESTRICTED; ignored otherwise. Provide an empty map to clear.

expires_atstring date-time

New expiration. Omit to keep current. Set clear_expires_at = true to remove an existing expiration.

clear_expires_atboolean

Force-clear the expiration. Mutually exclusive with expires_at.

Response

OK