Skip to main content
Docs

update()

Updates an OAuthApplication by its ID.

function update(params: UpdateOAuthApplicationParams): Promise<OAuthApplication>

UpdateOAuthApplicationParams

  • Name
    oauthApplicationId
    Type
    string
    Description

    The ID of the OAuth application to update.

  • Name
    name
    Type
    string
    Description

    The name of the OAuth application.

  • Name
    redirectUris?
    Type
    string[] | null | undefined
    Description

    An array of redirect URIs for the OAuth application.

  • Name
    scopes?
    Type
    string[] | null | undefined
    Description

    Scopes for the OAuth application. Available scopes are profile, email, public_metadata, private_metadata. Defaults to profile email. Provide the requested scopes as a string, separated by spaces.

  • Name
    consentScreenEnabled?
    Type
    boolean | null | undefined
    Description

    Specifies whether the consent screen should be displayed in the authentication flow. Cannot be disabled for dynamically registered OAuth applications. Defaults to true.

  • Name
    public?
    Type
    boolean | null | undefined
    Description

    Indicates whether the client is public. If true, the Proof Key of Code Exchange (PKCE) flow can be used.

Example

Note

Importing clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const oauthApplicationId = 'oauthapp_123'

const response = await clerkClient.oauthApplications.update({
  oauthApplicationId: oauthApplicationId,
  name: 'test',
  redirectUris: [''],
  scopes: 'profile email public_metadata private_metadata',
  public: true,
})

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on