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
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
function buildSignInUrl(options?: RedirectOptions): string;Returns the configured url where <SignIn /> is mounted or a custom sign-in page is rendered.
Properties
- Name
options- Type
RedirectOptions|undefined- Description
Options used to control the redirect in the constructed URL
function buildSignUpUrl(options?: RedirectOptions): string;Returns the configured url where <SignUp /> is mounted or a custom sign-up page is rendered.
Properties
- Name
options- Type
RedirectOptions|undefined- Description
Options used to control the redirect in the constructed URL
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. |
Feedback
Last updated on