New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

Update Issued API Key

PATCH 

/v2alpha1/admin/issuedApiKeys/:key_id

Updates metadata, scopes, or rate limits of an issued key without rotating the secret. Use RotateIssuedApiKey to change the secret.

Follows AIP-134: the request body is the IssuedApiKey resource itself, and the update_mask query parameter names the subset of fields to apply. Omitting update_mask is equivalent to a mask of every populated field in the body. To clear a field to its zero value, list it explicitly in update_mask and leave it unset (or empty) in the body.

PATCH /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ?update_mask=scopes
{
"issued_api_key": {
"key_id": "01HQZX9VYQKJB8XQZQXQZQXQXQ",
"scopes": ["read"]
}
}
SDK ReferenceTypeScript
adminUpdateIssuedApiKey(adminUpdateIssuedApiKeyRequest)
ParametersTypeRequiredDescription
adminUpdateIssuedApiKeyRequestAdminUpdateIssuedApiKeyRequestrequired
keyIdstringrequiredIdentifier of the API key resource.
updateMaskstringoptionalThe list of fields to update. See AIP-134.
VariableType
dataIssuedApiKey