Docs

Build URLs

These are all methods on the Clerk class that help you manage URL creation on the Clerk dashboard configuration.

buildUrlWithAuth()

Decorates the provided url with the auth token for development instances.

function buildUrlWithAuth(to: string, options?: BuildUrlWithAuthParams): string
  • Name
    to
    Type
    string
    Description

    The route to create a URL towards

  • Name
    options
    Type
    BuildUrlWithAuthParams
    Description

    Options to apply toward the URL builder

  • Name
    useQueryParam
    Type
    boolean | null | undefined
    Description

    Controls if dev browser JWT is added as a query param

buildSignInUrl()

Returns the configured url where <SignIn /> is mounted or a custom sign-in page is rendered.

function buildSignInUrl(options?: RedirectOptions): string
  • Name
    options
    Type
    RedirectOptions | undefined
    Description

    Options used to control the redirect in the constructed URL

buildSignUpUrl()

Returns the configured url where <SignUp /> is mounted or a custom sign-up page is rendered.

function buildSignUpUrl(options?: RedirectOptions): string
  • Name
    options
    Type
    RedirectOptions | undefined
    Description

    Options used to control the redirect in the constructed URL

buildUserProfileUrl()

Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.

function buildUserProfileUrl(): string

buildHomeUrl()

Returns the url that you've configured in your Clerk Dashboard.

function buildHomeUrl(): string

buildCreateOrganizationUrl()

Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.

function buildCreateOrganizationUrl(): string

buildOrganizationProfileUrl()

Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.

function buildOrganizationProfileUrl(): string

Feedback

What did you think of this content?

Last updated on