Skip to content

Commit f3428ca

Browse files
authored
Update verified domains page with necessary info (#2842)
1 parent 4d15017 commit f3428ca

File tree

3 files changed

+16
-14
lines changed

3 files changed

+16
-14
lines changed

docs/guides/organizations/verified-domains.mdx

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,19 @@ Enabling verified domains applies to all organizations and cannot currently be m
2121
In order to enable this feature:
2222

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

28-
### Enrollment mode
27+
- [**Automatic invitation**](#automatic-invitations) - Users are automatically invited to join the organization when they sign-up and can join anytime.
28+
- [**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.
2929

30-
You can enable the following enrollment modes to be available for your application:
31-
32-
- [**Automatic invitation**](#automatic-invitations) - Users are automatically invited to join the organization when they sign-up and can join anytime.
33-
- [**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.
34-
35-
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.
30+
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.**
3631

3732
### Automatic invitations
3833

39-
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.
34+
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.
35+
36+
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.
4037

4138
### Automatic suggestions
4239

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

4744
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.
4845

49-
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.
46+
When a user sends an organization membership request, users with the `org:sys_memberships:manage` permission (by default, admins) are notified through both:
47+
48+
- A notification badge on the `<OrganizationSwitcher />` component.
49+
- An email alert.
50+
51+
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.
5052

5153
## Add and verify domains
5254

docs/reference/javascript/organization.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ function getDomains(params?: GetDomainsParams): Promise<ClerkPaginatedResponse<O
227227
- `enrollmentMode?`
228228
- `'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion'`
229229

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

233233
#### Example

docs/reference/javascript/types/organization-domain.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The `OrganizationDomain` object is the model around an Organization domain.
3333
- `enrollmentMode`
3434
- `'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion'`
3535

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

3838
---
3939

0 commit comments

Comments
 (0)