Skip to main content
Docs

<OrganizationProfile /> component

The <OrganizationProfile /> component allows users to manage their organization membership and security settings.

The <OrganizationProfile /> component allows users to manage their organization membership, security, and billing settings.

This component's General tab displays the organization's information and the Leave organization button. Admins will be able to see the Update profile button, Verified domains section, and Delete organization button.

The Members tab shows the organization's members along with their join dates and roles. Admins will have the ability to invite a member, change a member's role, or remove them from the organization. Admins will have tabs within the Members tab to view the organization's invitations and requests.

The Billing tab displays the plans and features that are available to the organization, as well as the user's billing information, such as their invoices and payment methods.

Properties

The <OrganizationProfile /> component accepts the following properties, all of which are optional:

  • Name
    appearance
    Type
    Appearance | undefined
    Description

    Optional object to style your components. Will only affect Clerk components and not Account Portal pages.

  • Name
    afterLeaveOrganizationUrl
    Type
    string
    Description

    The full URL or path to navigate to after leaving an organization.

  • Name
    customPages
    Type
    CustomPages[]
    Description

    An array of custom pages to add to the organization profile. Only available for the . To add custom pages with React-based SDK's, see the dedicated guide.

  • Name
    fallback?
    Type
    ReactNode
    Description

    An optional element to be rendered while the component is mounting.

  • Name
    path
    Type
    string
    Description

    The path where the component is mounted on when routing is set to path. It is ignored in hash- and virtual-based routing.
    For example: /organization-profile.

  • Name
    routing
    Type
    'hash' | 'path'
    Description

    The routing strategy for your pages.
    Defaults to 'path' for frameworks that handle routing, such as Next.js and Remix. Defaults to hash for all other SDK's, such as React.

Usage with frameworks

The <OrganizationProfile /> component must embedded using the Next.js optional catch-all route in order for the routing to work.

app/organization-profile/[[...organization-profile]]/page.tsx
import { OrganizationProfile } from '@clerk/nextjs'

export default function OrganizationProfilePage() {
  return <OrganizationProfile />
}
organization-profile.tsx
import { OrganizationProfile } from '@clerk/clerk-react'

export default function OrganizationProfilePage() {
  return <OrganizationProfile />
}
/pages/organization-profile.astro
---
import { OrganizationProfile } from '@clerk/astro/components'
---

<OrganizationProfile />

Note

This component can be used in Expo Web projects, but won't work in native environments (iOS or Android). For native apps, use the supported native components instead.

/app/organization-profile.web.tsx
import { OrganizationProfile } from '@clerk/clerk-expo/web'

export default function OrganizationProfilePage() {
  return <OrganizationProfile />
}
/pages/organization-profile/$.tsx
import { OrganizationProfile } from '@clerk/remix'

export default function OrganizationProfilePage() {
  return <OrganizationProfile />
}
app/routes/organization-profile.tsx
import { OrganizationProfile } from '@clerk/tanstack-react-start'
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/organization-profile')({
  component: OrganizationProfilePage,
})

function OrganizationProfilePage() {
  return <OrganizationProfile />
}
organization-profile.vue
<script setup lang="ts">
import { OrganizationProfile } from '@clerk/vue'
</script>

<template>
  <OrganizationProfile />
</template>

Customization

To learn about how to customize Clerk components, see the customization documentation.

In addition, you also can add custom pages and links to the <OrganizationProfile /> navigation sidenav. For more information, refer to the Custom Pages documentation.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on