Revoke OAuth Client Secret
/{namespace}/{principalType}/{principalId}/oauth-clients/{clientId}/secrets/{secretId}Permanently revokes one secret belonging to the selected OAuth client. Other secrets remain active.
Required scope
Any authenticated access token
Path parameters
Header parameters
- Idempotency-Key
stringRequired Client-chosen key that makes a non-idempotent request retry-safe, following draft-ietf-httpapi-idempotency-key-header. A committed response is stored for 24 hours and replayed for the same principal, operation, key and payload. Missing key returns 400 IDEMPOTENCY_KEY_REQUIRED, a key longer than 255 characters returns 400 IDEMPOTENCY_KEY_INVALID, the same key with a different payload returns 422, and the same key while the first request is still in flight returns 409. Requests rolled back before external provider attempts do not consume the key. Group mutations retain terminal failed responses after provider attempts together with received provider truth; their operation contract defines these replayable outcomes.
minLength: 1
maxLength: 255
- If-Match
stringRequired The quoted strong entity tag of the resource the client last read (its `etag` field or `ETag` response header). The mutation is applied only when it still matches: a stale value returns 412 PRECONDITION_FAILED and a missing header returns 428 PRECONDITION_REQUIRED. Wildcards are accepted only where the operation explicitly permits them.
minLength: 1
Returns
200
Revoke OAuth Client Secret response.
No response body.
Errors
400 BAD_REQUESTInvalid request path.
Check the request fields and any validation details, then correct the payload.
401 UNAUTHORIZEDAuthentication required.
Obtain a valid access token, then retry.
403 FORBIDDENThe caller cannot read or manage the selected OAuth client.
Check the linked account and its permissions for the device or resource.
404 NOT_FOUNDOAuth client or secret not found.
Verify the target identifier and that its endpoint or plugin route still exists.
409 IDEMPOTENCY_KEY_IN_FLIGHTThe key is in flight.
Check the device’s current mode or state. Retry only after the conflict is resolved.
412 PRECONDITION_FAILEDThe secret version is stale.
Inspect the returned code and family and follow the error handling guide.
422 IDEMPOTENCY_KEY_REUSEDThe key was reused with a different payload.
Correct the rejected value using the constraints in the error details or request schema.
428 PRECONDITION_REQUIREDIf-Match is required.
Inspect the returned code and family and follow the error handling guide.
500 INTERNALInternal server error.
Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.