Organizations

Organizations are shared accounts, useful for project and team leaders. Organization members can usually collaborate across shared resources. Each member of an organization needs to have a user account in your application.

All organization members have access to most of the organization resources, but depending on their role, some members can take advantage of administrative features.

Clerk provides prebuilt components, React hooks, and APIs to help you integrate organizations into your application.

Roles

You can establish differentiation among member permissions through organization member roles. Roles determine a user's level of access to the organization. There are currently two roles: administrators and members.

• admin - Offers full access to organization resources. Members with the admin role have administrator privileges and can fully manage organizations and organization memberships.
• basic_member - The standard role for a user that is part of the organization. Access to organization resources is limited. Basic members cannot manage organizations and organization memberships, but can view information about the organization and other members in it.

Available actions

You can use Clerk's organizations feature to provide team grouping and sharing functionality for users of your applications.

Your users can create organizations. Organization owners effectively get the admin role.

All members of an organization, regardless of their role, can view information about other members in the same organization.

Administrators can invite other users to join the organization. An invitation email is sent out, and organization invitations support adding existing users of your application, or new ones. New users can register once they accept the invitation.

Administrators can also use verified domains to enhance how users can join organizations. Once a verified domain is added to an organization, administrators can choose between different enrollment modes that will determine how new members will be added.

Administrators can manage roles, such as revoking an invitation for a user that hasn't joined yet or removing a user who is already a member from the organization. When removing organization members or updating their role, there needs to be at least one administrator for the organization at all times.

Administrators can also update an organization name.

Using the Organizations Backend API, you can provide additional metadata for the organization and set custom attributes. Organizations support both private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. Learn more about organization metadata here.