POST/oauth_applications/{oauth_application_id}/rotate_secret

Rotate the client secret of the given OAuth application

Rotates the OAuth application's client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
oauth_application_idstringrequired
The ID of the OAuth application for which to rotate the client secret

3 status codes
200An OAuth application with client secret
objectstringrequired
Allowed:oauth_application
idstringrequired
instance_idstringrequired
namestringrequired
client_idstringrequired
client_uristringrequired
client_image_urlstringrequired
dynamically_registeredbooleanrequired
consent_screen_enabledbooleanrequired
pkce_requiredbooleanrequired
audience_uristringrequired
The active application audience URI, whose registry identity is permanently reserved to this application.
token_exchange_enabledbooleanrequired
Whether this confidential application accepts token exchanges from its active audience.
device_authorization_grant_enabledbooleanrequired
publicbooleanrequired
scopesstringrequired
The complete scope ceiling for the OAuth application, as a space-delimited list of built-in and assigned custom scope keys.
redirect_urisarray<string>required
callback_urlstringdeprecatedrequired
Deprecated: Use redirect_uris instead.
authorize_urlstringrequired
token_fetch_urlstringrequired
user_info_urlstringrequired
discovery_urlstringrequired
token_introspection_urlstringrequired
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
client_secretstringoptional
Empty if public client.
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 403 is returned: Authorization invalid. A 404 is returned: Resource not found.