Skip to main content
Docs

<RedirectToOrganizationProfile /> (deprecated)

Warning

This feature is deprecated. Please use the redirectToOrganizationProfile() method instead.

The <RedirectToOrganizationProfile /> component will navigate to the organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.

Usage with JavaScript

The following method available on an instance of the Clerk class is used to render and control the <RedirectToOrganizationProfile /> component:

The following examples assume that you have followed the quickstart in order to add Clerk to your JavaScript application.

redirectToOrganizationProfile()

Render the <RedirectToOrganizationProfile /> component to an HTML <div> element.

function redirectToOrganizationProfile(): Promise<unknown>

redirectToOrganizationProfile() usage

main.js
import { Clerk } from '@clerk/clerk-js'

// Initialize Clerk with your Clerk Publishable Key
const clerkPubKey = import.meta.env.VITE_CLERK_PUBLISHABLE_KEY

const clerk = new Clerk(clerkPubKey)
await clerk.load()

await clerk.redirectToOrganizationProfile()

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on