Skip to content

Commit 27bb678

Browse files
committed
docs review
1 parent 019a616 commit 27bb678

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+168
-205
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
| Property | Type | Description |
22
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3-
| <a id="domains"></a> `domains?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/add-members/verified-domains#enrollment-mode).</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
3+
| <a id="domains"></a> `domains?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/verified-domains#enrollment-mode).</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
44
| <a id="invitations"></a> `invitations?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "revoked" \| "pending" \| "accepted")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`status`: A string that filters the invitations by the provided status.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
55
| <a id="membershiprequests"></a> `membershipRequests?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "revoked" \| "pending" \| "accepted"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`status`: A string that filters the membership requests by the provided status.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
66
| <a id="memberships"></a> `memberships?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ query?: string; role?: string[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`role`: An array of [`OrganizationCustomRoleKey`](/docs/reference/javascript/types/organization-custom-role-key).</li> <li>`query`: A string that filters the memberships by the provided string.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |

clerk-typedoc/types/check-authorization-params-from-session-claims.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Property | Type | Description |
44
| --------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
55
| <a id="feature"></a> `feature?` | `Autocomplete`\<<code> user:${string} \| org:${string} </code>\> | The [feature](/docs/guides/billing/overview) to check for. |
6-
| <a id="permission"></a> `permission?` | `DisallowSystemPermissions`\<`P`\> | The [permission](/docs/guides/organizations/control-access/roles-and-permissions) to check for. |
6+
| <a id="permission"></a> `permission?` | `DisallowSystemPermissions`\<`P`\> | The [permission](/docs/guides/organizations/roles-and-permissions) to check for. |
77
| <a id="plan"></a> `plan?` | `Autocomplete`\<<code> user:${string} \| org:${string} </code>\> | The [plan](/docs/guides/billing/overview) to check for. |
88
| <a id="reverification"></a> `reverification?` | [`ReverificationConfig`](reverification-config.mdx) | The reverification configuration to check for. This feature is currently in public beta. **It is not recommended for production use.** |
9-
| <a id="role"></a> `role?` | `string` | The [role](/docs/guides/organizations/control-access/roles-and-permissions) to check for. |
9+
| <a id="role"></a> `role?` | `string` | The [role](/docs/guides/organizations/roles-and-permissions) to check for. |
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
`OrganizationCustomRoleKey` is a type that represents the user's role in an organization. It will be string unless the developer has provided their own types through [`ClerkAuthorization`](/docs/guides/development/override-clerk-types-interfaces#example-custom-roles-and-permissions).
22

3-
Clerk provides the [default roles](/docs/guides/organizations/control-access/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](/docs/guides/organizations/control-access/roles-and-permissions#custom-roles) as well.
3+
Clerk provides the [default roles](/docs/guides/organizations/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](/docs/guides/organizations/roles-and-permissions#custom-roles) as well.

docs/_partials/has-warning.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
> [!WARNING]
2-
> Using `has()` **on the server-side** to check permissions works only with **custom permissions**, as [system permissions](/docs/guides/organizations/control-access/roles-and-permissions#system-permissions) aren't included in the session token claims. To check system permissions, verify the user's role instead.
2+
> Using `has()` **on the server-side** to check permissions works only with **custom permissions**, as [system permissions](/docs/guides/organizations/roles-and-permissions#system-permissions) aren't included in the session token claims. To check system permissions, verify the user's role instead.

docs/guides/billing/for-b2b.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Clerk billing for B2B SaaS allows you to create plans and manage subscriptions *
1212

1313
## Create a plan
1414

15-
Subscription plans are what your customers subscribe to. There is no limit to the number of plans you can create. If your Clerk instance has existing [custom permissions](/docs/guides/organizations/control-access/roles-and-permissions), the corresponding features from those permissions will automatically be added to the free plan for orgs. This ensures that organization members get the same set of custom permissions when billing is enabled, because all organizations start on the free plan.
15+
Subscription plans are what your customers subscribe to. There is no limit to the number of plans you can create. If your Clerk instance has existing [custom permissions](/docs/guides/organizations/roles-and-permissions), the corresponding features from those permissions will automatically be added to the free plan for orgs. This ensures that organization members get the same set of custom permissions when billing is enabled, because all organizations start on the free plan.
1616

1717
To create a plan, navigate to the [**Plans**](https://dashboard.clerk.com/~/billing/plans) page in the Clerk Dashboard. Here, you can create, edit, and delete plans. To setup B2B billing, select the **Plans for Organizations** tab and select **Add Plan**. When creating a plan, you can also create [features](/docs/guides/secure/features) for the plan; see the next section for more information.
1818

docs/guides/development/custom-flows/account-updates/user-impersonation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide will walk you through how to build a custom flow that handles user im
1313

1414
<Tabs items={["Next.js", "Expo"]}>
1515
<Tab>
16-
The following example builds a dashboard that is only accessible to users with the `org:admin:impersonate` permission. To use this example, you must first [create the custom `org:admin:impersonate` permission](/docs/guides/organizations/control-access/roles-and-permissions#custom-permissions). Or you can modify the [authorization checks](!authorization-check) to fit your use case.
16+
The following example builds a dashboard that is only accessible to users with the `org:admin:impersonate` permission. To use this example, you must first [create the custom `org:admin:impersonate` permission](/docs/guides/organizations/roles-and-permissions#custom-permissions). Or you can modify the [authorization checks](!authorization-check) to fit your use case.
1717

1818
In the dashboard, the user will see a list of the application's users. When the user chooses to impersonate a user, they will be signed in as that user and redirected to the homepage.
1919

docs/guides/development/custom-flows/organizations/accept-organization-invitations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ description: Learn how to use the Clerk API to build a custom flows for acceptin
55

66
<Include src="_partials/custom-flows-callout" />
77

8-
When a user visits an [organization invitation](/docs/guides/organizations/add-members/invitations) link, Clerk first checks whether a custom redirect URL was provided.
8+
When a user visits an [organization invitation](/docs/guides/organizations/invitations) link, Clerk first checks whether a custom redirect URL was provided.
99

1010
**If no redirect URL is specified**, the user will be redirected to the appropriate Account Portal page (either [sign-up](/docs/guides/customizing-clerk/account-portal#sign-up) or [sign-in](/docs/guides/customizing-clerk/account-portal#sign-in)), or to the custom sign-up/sign-in pages that you've configured for your application.
1111

12-
**If you specified [a redirect URL when creating the invitation](/docs/guides/organizations/add-members/invitations#redirect-url)**, you must handle the authentication flows in your code for that page. You can either embed the [`<SignIn />`](/docs/reference/components/authentication/sign-in) component on that page, or if the prebuilt component doesn't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API.
12+
**If you specified [a redirect URL when creating the invitation](/docs/guides/organizations/invitations#redirect-url)**, you must handle the authentication flows in your code for that page. You can either embed the [`<SignIn />`](/docs/reference/components/authentication/sign-in) component on that page, or if the prebuilt component doesn't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API.
1313

1414
This guide demonstrates how to use Clerk's API to build a custom flow for accepting organization invitations from a link.
1515

docs/guides/development/custom-flows/organizations/manage-membership-requests.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to use the Clerk API to build a custom flow for managing
55

66
<Include src="_partials/custom-flows-callout" />
77

8-
This guide will demonstrate how to use the Clerk API to build a custom flow for managing [organization membership requests](/docs/guides/organizations/add-members/verified-domains#membership-requests).
8+
This guide will demonstrate how to use the Clerk API to build a custom flow for managing [organization membership requests](/docs/guides/organizations/verified-domains#membership-requests).
99

1010
<Tabs items={["Next.js", "JavaScript"]}>
1111
<Tab>

docs/guides/development/custom-flows/organizations/manage-organization-invitations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: Learn how to use the Clerk API to build a custom flow for creating
55

66
<Include src="_partials/custom-flows-callout" />
77

8-
Organization members with appropriate [permissions](/docs/guides/organizations/control-access/roles-and-permissions) can invite new users to their organization and manage those invitations. The invitation recipient can be either an existing user of your application or a new user. If they are a new user, they will need to sign up in order to accept the invitation.
8+
Organization members with appropriate [permissions](/docs/guides/organizations/roles-and-permissions) can invite new users to their organization and manage those invitations. The invitation recipient can be either an existing user of your application or a new user. If they are a new user, they will need to sign up in order to accept the invitation.
99

1010
Users with the appropriate permissions can also revoke organization invitations for users that have not yet joined, which will prevent the user from becoming an organization member.
1111

1212
This guide will demonstrate how to use the Clerk API to build a custom flow for inviting users to an organization and managing an organization's pending invitations.
1313

1414
> [!NOTE]
15-
> This guide is for creating and managing organization invitations client-side. You can also create an organization invitation using the Backend API. See the [organization invitations reference](/docs/guides/organizations/add-members/invitations) for more information.
15+
> This guide is for creating and managing organization invitations client-side. You can also create an organization invitation using the Backend API. See the [organization invitations reference](/docs/guides/organizations/invitations) for more information.
1616
>
1717
> Also, see the [custom flow for accepting organization invitations](/docs/guides/development/custom-flows/organizations/accept-organization-invitations).
1818

docs/guides/development/custom-flows/organizations/manage-roles.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to use the Clerk API build a custom flow for managing mem
55

66
<Include src="_partials/custom-flows-callout" />
77

8-
Organization members with appropriate [permissions](/docs/guides/organizations/control-access/roles-and-permissions#permissions) can manage a member's [role](/docs/guides/organizations/control-access/roles-and-permissions#roles) and remove members within an organization.
8+
Organization members with appropriate [permissions](/docs/guides/organizations/roles-and-permissions#permissions) can manage a member's [role](/docs/guides/organizations/roles-and-permissions#roles) and remove members within an organization.
99

1010
This guide will demonstrate how to use the Clerk API to build a custom flow for managing member roles in an organization.
1111

0 commit comments

Comments
 (0)