Catalog
Revoke one of the merchant's keys
Revokes one of the merchant's keys and answers 204; the key stops authenticating at once.
DELETE
/v1/clients/{clientId}/api_keys/{keyId}Revokes one of the merchant's keys and answers 204; the key stops authenticating at once. Only a person may revoke a key, so a key is refused consumer_token_required (403), and the caller must have authority over the client. An unknown key gives key_not_found (404) and a deployment without merchant keys merchant_keys_disabled (501).
Authorization
bearerAuth AuthorizationBearer <token>
A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
clientId*string
Format
uuidkeyId*string
Format
uuidResponse Body
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/api_keys/497f6eca-6276-4993-bfeb-53cbbbba6f08"Empty