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
| Name | Type | Description |
|---|
to | string | The route to create a URL towards |
options | BuildUrlWithAuthParams | Options to apply toward the URL builder |
BuildUrlWithAuthParams
| Name | Type | Description |
|---|
useQueryParam | boolean | null | undefined | Controls if dev browser JWT is added as a query param |
Returns
| Type | Description |
|---|
string | The 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
| Name | Type | Description |
|---|
options | RedirectOptions | undefined | Options used to control the redirect in the constructed URL |
Returns
| Type | Description |
|---|
string | The 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
| Name | Type | Description |
|---|
options | RedirectOptions | undefined | Options used to control the redirect in the constructed URL |
Returns
| Type | Description |
|---|
string | The built sign-up URL |
buildUserProfileUrl()
function buildUserProfileUrl(): string;
Returns the url where UserProfile is mounted or a custom user-profile page is rendered.
Returns
| Type | Description |
|---|
string | The 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
| Type | Description |
|---|
string | The 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
| Type | Description |
|---|
string | The 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
| Type | Description |
|---|
string | The configured url where OrganizationProfile is mounted or a custom organization-profile page is rendered. |
