Skip to main content

update()

Updates the given OAuth application.

Returns the updated OAuthApplication object.

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

UpdateOAuthApplicationParams

  • Name
    name
    Type
    string
    Description

    A descriptive name for the OAuth application (e.g., "My Web App", "My Mobile App"). Maximum length: 256 characters.

  • Name
    oauthApplicationId
    Type
    string
    Description

    The ID of the OAuth application to update.

  • Name
    public?
    Type
    boolean | null
    Description

    Whether the OAuth application is public. If true, the Proof Key of Code Exchange (PKCE) flow can be used.

  • Name
    redirectUris?
    Type
    string[] | null
    Description

    An array of redirect URIs for the OAuth application.

  • Name
    scopes?
    Type
    string | null
    Description

    Scopes for the OAuth application that dictate the user payload of the OAuth user info endpoint. Available scopes are profile, email, public_metadata, private_metadata. Provide the requested scopes as a string, separated by spaces.

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.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?

Last updated on

GitHubEdit on GitHub