Skip to main content

rotateSecret()

Rotates the secret of the given OAuth application. When the client secret is rotated, ensure that you update it in your authorized OAuth clients.

Returns the OAuthApplication object.

function rotateSecret(oauthApplicationId: string): Promise<OAuthApplication>

Parameters

  • Name
    oauthApplicationId
    Type
    string
    Description

    The ID of the OAuth application to rotate the secret of.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const oauthApplicationId = 'oauthapp_123'

const response = await clerkClient.oauthApplications.rotateSecret(oauthApplicationId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/oauth_applications/{oauth_application_id}/rotate_secret. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub