Rotate a confidential client's secret
POST /v1/oauth/clients/{client}/secret: Rotate a confidential client's secret.
POST /
- Scope
oauth:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”clientstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK OAuthClientSecret
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/oauth/clients/ocl_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/secret" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/oauth/clients/ocl_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/secret", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/oauth/clients/ocl_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/secret", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "object": "oauth_client_secret", "client_secret": "sk_test_example", "previous_secret_expires_at": "2026-01-15T09:30:00Z"}