Skip to content

Commit be700f3

Browse files
author
tu
committed
update copy for active voice
1 parent f2ca024 commit be700f3

File tree

10 files changed

+25
-25
lines changed

10 files changed

+25
-25
lines changed

docs/guides/organizations/add-members/invitations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
title: Send and manage Organization invitations via Clerk
66
---
77

8-
Organization invitations let you add new members to your organization. When you send an invitation, Clerk sends an email to the invited user with a unique invitation link. When the user visits the organization invitation link, they will be redirected to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in). If the user is already signed in, they will be redirected to your application's homepage (`/`). If you want to redirect the user to a specific page in your application, you can [specify a redirect URL when creating the invitation](#redirect-url).
8+
Organization invitations let you add new members to your organization. When you send an invitation, Clerk sends an email to the invited user with a unique invitation link. When the user visits the organization invitation link, Clerk redirects them to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in). If the user is already signed in, Clerk redirects them to your application's homepage (`/`). If you want to redirect the user to a specific page in your application, you can [specify a redirect URL when creating the invitation](#redirect-url).
99

1010
By default, only [admins](/docs/guides/organizations/control-access/roles-and-permissions#default-roles) can invite users to an organization.
1111

@@ -97,7 +97,7 @@ Once the user visits the invitation link, they will be redirected to the page yo
9797
9898
### Invitation metadata
9999

100-
You can also add metadata to an invitation when creating the invitation through the Backend API. Once the invited user signs up using the invitation link, the **invitation** metadata (`OrganizationInvitation.publicMetadata`) will be stored in the organization **membership's** metadata (`OrganizationMembership.publicMetadata`). You can find more information about organization membership metadata in the [Organization
100+
You can also add metadata to an invitation when creating the invitation through the Backend API. Once the invited user signs up using the invitation link, Clerk stores the **invitation** metadata (`OrganizationInvitation.publicMetadata`) in the organization **membership's** metadata (`OrganizationMembership.publicMetadata`). You can find more information about organization membership metadata in the [Organization
101101
Membership](/docs/reference/javascript/types/organization-membership) docs.
102102

103103
To add metadata to an invitation, add the `public_metadata` parameter when creating the invitation.

docs/guides/organizations/add-members/sso.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
title: Set up organization-level SAML and OIDC for B2B/B2C apps
66
---
77

8-
Clerk provides enterprise single sign-on (SSO) through a feature called **enterprise connections**. You can enable enterprise connections for specific organizations, allowing members to authenticate through their company's identity provider using SAML or OIDC protocols. When users sign up or sign in using an organization's enterprise connection, they're automatically added as members of that organization and assigned the [default role](/docs/guides/organizations/control-access/roles-and-permissions#the-default-role-for-members).
8+
Clerk provides enterprise single sign-on (SSO) through a feature called **enterprise connections**. You can enable enterprise connections for specific organizations, allowing members to authenticate through their company's identity provider using SAML or OIDC protocols. When users sign up or sign in using an organization's enterprise connection, Clerk automatically adds them as members of that organization and assigns them the [default role](/docs/guides/organizations/control-access/roles-and-permissions#the-default-role-for-members).
99

1010
## When to use enterprise SSO
1111

@@ -43,14 +43,14 @@ This flow is common when individual users try the product before company-wide ad
4343

4444
Clerk supports enterprise SSO via [SAML](/docs/guides/configure/auth-strategies/enterprise-connections/overview#saml) or via the [OpenID Connect (OIDC) protocol](/docs/guides/configure/auth-strategies/enterprise-connections/overview#oidc), either through EASIE or by integrating with any OIDC-compatible provider.
4545

46-
To add an enterprise SSO connection for an organization, follow the appropriate guide based on the platform you want to use, such as the [Google SAML guide](/docs/guides/configure/auth-strategies/enterprise-connections/saml/google). When configuring the connection in the Clerk Dashboard, there will be an option to select the **Organization** for which you want to enable this connection. If you don't select an organization, the connection will be added for your entire application.
46+
To add an enterprise SSO connection for an organization, follow the appropriate guide based on the platform you want to use, such as the [Google SAML guide](/docs/guides/configure/auth-strategies/enterprise-connections/saml/google). When configuring the connection in the Clerk Dashboard, there will be an option to select the **Organization** for which you want to enable this connection. If you don't select an organization, Clerk will add the connection for your entire application.
4747

4848
> [!WARNING]
4949
> A domain used for enterprise SSO can't be used as a [verified domain](/docs/guides/organizations/add-members/verified-domains) for the same organization.
5050
5151
## Enforce enterprise SSO by domain
5252

53-
Enterprise SSO connections are enforced on a per-domain basis in organizations, enabling flexible access management:
53+
Clerk enforces enterprise SSO connections on a per-domain basis in organizations, enabling flexible access management:
5454

5555
- Configure enterprise SSO for your primary domain (e.g., `company.com`) to enforce enterprise SSO authentication for employees.
5656
- Add additional domains without enterprise SSO for external collaborators (e.g., contractors, consultants).

docs/guides/organizations/add-members/verified-domains.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
title: Verified domains within Clerk Organizations (Step-by-Step)
66
---
77

8-
Clerk's **verified domains** feature is useful for organizations that want to restrict membership to users with specific email domains, and automatically invite or suggest users with that domain to join an organization. For example, if the domain `@clerk.com` is verified, any user with an email address ending in `@clerk.com` can be automatically invited or be suggested to join an organization with that domain. The role assigned to this user will be the role set as the [**Default** role](/docs/guides/organizations/control-access/roles-and-permissions#the-default-role-for-members) in the organization settings page.
8+
Clerk's **verified domains** feature is useful for organizations that want to restrict membership to users with specific email domains, and automatically invite or suggest users with that domain to join an organization. For example, if the domain `@clerk.com` is verified, any user with an email address ending in `@clerk.com` can be automatically invited or be suggested to join an organization with that domain. Clerk assigns users the [**Default** role](/docs/guides/organizations/control-access/roles-and-permissions#the-default-role-for-members) set in the organization settings page.
99

1010
A verified domain cannot be a disposable domain or common email provider. For example, you cannot create a verified domain for `@gmail.com`.
1111

@@ -39,7 +39,7 @@ In order to enable this feature:
3939

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

42-
- [**Automatic invitation**](#automatic-invitations) - Users are automatically invited to join the organization when they sign-up and can join anytime.
42+
- [**Automatic invitation**](#automatic-invitations) - Clerk automatically invites users to join the organization when they sign up and they can join anytime.
4343
- [**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.
4444

4545
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.
@@ -60,9 +60,9 @@ When a user sends an organization membership request, users with the `org:sys_me
6060

6161
## Add and verify domains
6262

63-
Domains can be added and verified under an organization by any user with the `org:sys_domains:manage` permission. By default, admins have this permission. To add and verify domains in the [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher) component, select the **General** tab. There will be a **Verified domains** section.
63+
Any user with the `org:sys_domains:manage` permission can add and verify domains under an organization. By default, admins have this permission. To add and verify domains in the [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher) component, select the **General** tab. There will be a **Verified domains** section.
6464

65-
Domains can be verified through an email verification code sent to an email that matches the domain. If the user adding the domain already has a verified email using that domain in their account, the domain will be automatically verified.
65+
You can verify domains through an email verification code sent to an email that matches the domain. If the user adding the domain already has a verified email using that domain in their account, Clerk will automatically verify the domain.
6666

6767
An application instance may only have one verified domain of the same name, and an organization may only have one domain of the same name (verified or unverified).
6868

docs/guides/organizations/configure.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To enable organizations:
3030
1. In the modal, toggle **Allow personal accounts** based on your decision above.
3131
1. Select **Enable**.
3232

33-
Organizations are measured by Monthly Active Organizations (MAOs). Refer to the [overview page](/docs/guides/organizations/overview#how-do-organizations-work) for pricing details and limits.
33+
Clerk measures Organizations by Monthly Active Organizations (MAOs). Refer to the [overview page](/docs/guides/organizations/overview#how-do-organizations-work) for pricing details and limits.
3434

3535
## Organization Options
3636

@@ -161,7 +161,7 @@ This setting controls whether organization members can delete organizations.
161161

162162
### Allow new members to delete Organizations
163163

164-
By default, organizations are deletable. any member with the ["Delete organization" system permission](/docs/guides/organizations/control-access/roles-and-permissions#system-permissions) can delete an organization. You can disable this if you want to prevent accidental data loss or require your own approval process before organizations are removed.
164+
By default, any member with the ["Delete organization" system permission](/docs/guides/organizations/control-access/roles-and-permissions#system-permissions) can delete an organization. You can disable this if you want to prevent accidental data loss or require your own approval process before organizations are removed.
165165

166166
To prevent members from deleting organizations:
167167

docs/guides/organizations/control-access/check-access.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Clerk provides two primary ways to perform these checks: the `has()` method for
1414
Authorization checks can verify roles and custom permissions. Roles like `org:admin` determine a user's level of access within an organization, while custom permissions like `org:invoices:create` provide fine-grained control over specific features and actions.
1515

1616
> [!IMPORTANT]
17-
> Custom permissions are linked to features. A permission check for `org:invoices:create` will only return `true` if the organization's active plan includes the `invoices` feature **and** the user has the permission. Learn more in the [roles and permissions guide](/docs/guides/organizations/control-access/roles-and-permissions#custom-permissions).
17+
> Clerk links custom permissions to features. A permission check for `org:invoices:create` will only return `true` if the organization's active plan includes the `invoices` feature **and** the user has the permission. Learn more in the [roles and permissions guide](/docs/guides/organizations/control-access/roles-and-permissions#custom-permissions).
1818
1919
## Frontend checks with `<Protect>`
2020

docs/guides/organizations/control-access/roles-and-permissions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For each instance, there are currently two default roles:
2222

2323
### The **Creator** role
2424

25-
When a user creates a new organization, they're automatically added as its first member and assigned the organization's designated **Creator** role. By default, that role is `org:admin`.
25+
When a user creates a new organization, Clerk automatically adds them as its first member and assigns them the organization's designated **Creator** role. By default, that role is `org:admin`.
2626

2727
You cannot delete an organization role if it's used as the organization's **Creator** role. But, you _can_ reassign the **Creator** role to any other role with the right permissions. For example, if you want to delete the `admin` role, you will have to assign another role as the **Creator** role.
2828

docs/guides/organizations/create-and-manage.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ metadata:
55
title: Create and manage Organizations with Clerk
66
---
77

8-
Organizations can be created by developers in the Clerk Dashboard or by end users in your application. Once created, you can manage individual organization profiles, update settings, and help users switch between multiple organizations.
8+
You can create organizations in the Clerk Dashboard, or end users can create them in your application. Once created, you can manage individual organization profiles, and update settings. Clerk provides components to help users switch between multiple organizations.
99

1010
This guide covers working with individual organizations. For global settings that affect all organizations in your application (like enabling organizations, setting default roles, or configuring membership), refer to [Configure Organizations](/docs/guides/organizations/configure).
1111

1212
## Create an organization
1313

14-
Organizations can be created in the Clerk Dashboard by developers or in your application by end users. The number of organizations you can create depends on your [Monthly Active Organization (MAO) limits](/docs/guides/organizations/overview#how-do-organizations-work).
14+
You can create organizations in the Clerk Dashboard, or end users can create them in your application. The number of organizations you can create depends on your [Monthly Active Organization (MAO) limits](/docs/guides/organizations/overview#how-do-organizations-work).
1515

1616
### Create an organization in the Clerk Dashboard
1717

1818
To create an organization in the Clerk Dashboard:
1919

2020
1. In the Clerk Dashboard, select [**Organizations**](https://dashboard.clerk.com/~/organizations).
2121
1. Select the **Create Organization** button.
22-
1. Enter the organization's name. Optionally, upload the organization's logo, enter the organization's slug, and select the organization's owner. The slug is a unique identifier for the organization that is used in URLs, such as `example-name`.
22+
1. Enter the organization's name. Optionally, upload the organization's logo, enter the organization's slug, and select the organization's owner. The slug is a unique identifier for the organization that you can use in URLs, such as `example-name`.
2323

2424
### Create an organization in your application
2525

docs/guides/organizations/org-slugs-in-urls.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Alternatively, [organization IDs](/docs/reference/javascript/organization#proper
4545

4646
### When to use organization slugs
4747

48-
This feature is intended for apps that **require** organization slugs in URLs. **Adding slugs to URLs isn't recommended unless necessary.**
48+
This feature is intended for apps that **require** organization slugs in URLs. **We don't recommend adding slugs to URLs unless necessary.**
4949

5050
Use organization slugs if:
5151

@@ -155,7 +155,7 @@ This guide shows you how to add organization slugs to your app's URLs, configure
155155

156156
Failed activation occurs if no organization with the specified slug exists, or if the given user isn't a member of the organization. When this happens, the middleware won't change the active organization, leaving the previously active one unchanged.
157157

158-
For troubleshooting, a message will also be logged on the server:
158+
For troubleshooting, Clerk will also log a message on the server:
159159

160160
> Clerk: Organization activation handshake loop detected. This is likely due to an invalid organization ID or slug. Skipping organization activation.
161161

0 commit comments

Comments
 (0)