Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions docs/guides/organizations/verified-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,19 @@ Enabling verified domains applies to all organizations and cannot currently be m
In order to enable this feature:

1. In the Clerk Dashboard, navigate to the [**Organizations Settings**](https://dashboard.clerk.com/~/organizations-settings) page.
1. In the **Verified domains** section, enable **Enable verified domains**.
1. The following setting will appear:
- [**Enrollment mode**](#enrollment-mode) - **Automatic invitation** and **Automatic suggestion**.
1. In the **Organization options** section, toggle on **Enable verified domains**.
1. The following enrollment modes will appear that can be enabled for verified domains:

### Enrollment mode
- [**Automatic invitation**](#automatic-invitations) - Users are automatically invited to join the organization when they sign-up and can join anytime.
- [**Automatic suggestion**](#automatic-suggestions) - Users receive a suggestion to request to join, but must be approved by an admin before they are able to join the organization.

You can enable the following enrollment modes to be available for your application:

- [**Automatic invitation**](#automatic-invitations) - Users are automatically invited to join the organization when they sign-up and can join anytime.
- [**Automatic suggestion**](#automatic-suggestions) - Users receive a suggestion to request to join, but must be approved by an admin before they are able to join the organization.

Then, in your application, when a user with the `org:sys_domains:manage` permission has added and verified a domain, they can enable an enrollment mode. Only one enrollment mode can be enabled for a verified domain at a time.
When a user with the `org:sys_domains:manage` permission has added and verified a domain in your application, they can enable an enrollment mode. **Only one enrollment mode can be enabled for a verified domain at a time.**

### Automatic invitations

After sign-up, a user will receive an **invitation** for the organization if their email's domain matches the verified domain. If your app uses the `<OrganizationSwitcher />` component, the user will see a notification on the component. When they open the component, they will see a **Join** button next to the organization they were invited to. Selecting the button will accept the invitation and the user will instantly be added as a member of the organization.
After sign-up, a user will receive an **invitation** for the organization if their email's domain matches the verified domain. If your app uses the `<OrganizationSwitcher />` component, the user will see a notification on the component and also receive an email prompting them to accept the invitation.

When they open the component, they will see a **Join** button next to the organization they were invited to. Selecting the button will accept the invitation and the user will instantly be added as a member of the organization.

### Automatic suggestions

Expand All @@ -46,7 +43,12 @@ After sign-up, a user will receive a **suggestion** for the organization if thei

Membership requests are requests from users who saw an organization suggestion and requested to join an organization. Membership requests are only available for organizations that have the **Verified domains** feature enabled and the **Automatic suggestions** feature enabled in both the Dashboard and for the specific domain.

When a user sends an organization membership request, users with the `org:sys_memberships:manage` permission (by default, admins) will see a notification on their `<OrganizationSwitcher />` component. They will need to accept the request before the user can join the organization.
When a user sends an organization membership request, users with the `org:sys_memberships:manage` permission (by default, admins) are notified through both:

- A notification badge on the `<OrganizationSwitcher />` component.
- An email alert.

Regardless of how they are notified, membership requests can only be reviewed and managed through the `<OrganizationSwitcher />` component. Selecting the notification badge will open the organization management page, where the request appears under `Members > Requests`. A request must be approved before the user is added to the organization.

## Add and verify domains

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/javascript/organization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ function getDomains(params?: GetDomainsParams): Promise<ClerkPaginatedResponse<O
- `enrollmentMode?`
- `'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion'`

An [enrollment mode](/docs/guides/organizations/verified-domains#enrollment-mode) will change how new users join an organization.
An [enrollment mode](/docs/guides/organizations/verified-domains#enable-verified-domains) will change how new users join an organization.
</Properties>

#### Example
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/javascript/types/organization-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The `OrganizationDomain` object is the model around an Organization domain.
- `enrollmentMode`
- `'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion'`

An [enrollment mode](/docs/guides/organizations/verified-domains#enrollment-mode) will change how new users join an Organization.
An [enrollment mode](/docs/guides/organizations/verified-domains#enable-verified-domains) will change how new users join an Organization.

---

Expand Down