Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

Build URLs

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

buildUrlWithAuth()

function buildUrlWithAuth(to: string, options?: BuildUrlWithAuthParams): string;

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

Properties

NameTypeDescription
tostringThe route to create a URL towards
optionsBuildUrlWithAuthParamsOptions to apply toward the URL builder

BuildUrlWithAuthParams

NameTypeDescription
useQueryParamboolean | null | undefinedControls if dev browser JWT is added as a query param

Returns

TypeDescription
stringThe built URL decorated with the auth token

buildSignInUrl()

function buildSignInUrl(options?: RedirectOptions): string;

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

Properties

NameTypeDescription
optionsRedirectOptions | undefinedOptions used to control the redirect in the constructed URL

Returns

TypeDescription
stringThe built sign-in URL

buildSignUpUrl()

function buildSignUpUrl(options?: RedirectOptions): string;

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

Properties

NameTypeDescription
optionsRedirectOptions | undefinedOptions used to control the redirect in the constructed URL

Returns

TypeDescription
stringThe built sign-up URL

buildUserProfileUrl()

function buildUserProfileUrl(): string;

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

Returns

TypeDescription
stringThe url where UserProfile is mounted or a custom user-profile page is rendered.

buildHomeUrl()

function buildHomeUrl(): string;

Returns the url that you've configured in your app's Clerk dashboard.

Returns

TypeDescription
stringThe url that you've configured in your app's Clerk dashboard.

buildCreateOrganizationUrl()

function buildCreateOrganizationUrl(): string;

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

Returns

TypeDescription
stringThe configured url where CreateOrganization is mounted or a custom create-organization page is rendered.

buildOrganizationProfileUrl()

function buildOrganizationProfileUrl(): string;

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

Returns

TypeDescription
stringThe configured url where OrganizationProfile is mounted or a custom organization-profile page is rendered.

Last updated on October 10, 2023

What did you think of this content?

Clerk © 2024