You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`canonical`|`string`| -| The canonical URL to avoid duplicate content across versions or domains. |
396
396
397
397
```diff
398
398
---
@@ -409,7 +409,7 @@ The `metadata` frontmatter field can be used to define additional information ab
409
409
410
410
<details>
411
411
<summary>Configure Open Graph metadata for social media previews</summary>
412
-
<br />
412
+
<br />
413
413
<p><strong>This is set via the <code>openGraph</code> field. It has the following subfields:</strong></p>
414
414
415
415
| Name | Type | Default | Description |
@@ -425,7 +425,7 @@ The `metadata` frontmatter field can be used to define additional information ab
425
425
title: Example
426
426
+ metadata:
427
427
+ openGraph:
428
-
+ title: Clerk organizations - invite users
428
+
+ title: Clerk Organizations - invite users
429
429
+ description: Guide to sending and managing invitations within Clerk.
430
430
+ images:
431
431
+ - https://example.com/social-preview.png
@@ -436,7 +436,7 @@ The `metadata` frontmatter field can be used to define additional information ab
436
436
437
437
<details>
438
438
<summary>Define X Cards metadata for the page</summary>
439
-
<br />
439
+
<br />
440
440
<p><strong>This is set via the <code>twitter</code> field. It has the following subfields:</strong></p>
441
441
442
442
| Name | Type | Default | Description |
@@ -450,7 +450,7 @@ The `metadata` frontmatter field can be used to define additional information ab
450
450
title: Example
451
451
+ metadata:
452
452
+ twitter:
453
-
+ title: Clerk organizations - invite users
453
+
+ title: Clerk Organizations - invite users
454
454
+ description: Guide to sending and managing invitations within Clerk.
455
455
+ images:
456
456
+ - https://example.com/social-preview.png
@@ -461,7 +461,7 @@ The `metadata` frontmatter field can be used to define additional information ab
461
461
462
462
<details>
463
463
<summary>Control search engine indexing and crawler behavior.</summary>
464
-
<br />
464
+
<br />
465
465
<p><strong>This is set via the <code>robots</code> field. It has the following subfields:</strong></p>
466
466
467
467
| Name | Type | Default | Description |
@@ -942,7 +942,7 @@ Tooltips are defined in the `_tooltips` folder and written in MDX, but they do n
942
942
The tooltip syntax is similar to a link, but with a `!` prefix, as shown in the following example:
943
943
944
944
```mdx
945
-
The ID of the [active organization](!active-organization) that the user belongs to.
945
+
The ID of the [Active Organization](!active-organization) that the user belongs to.
946
946
```
947
947
948
948
Tooltips should follow the same styleguide as links - only add them on the first mention of a term and only in the highest heading section. So if a term is mentioned in an H2 section and again in its H3 section, it doesn't need to be added in the H3 section.
To enable billing for your application, navigate to the [**Billing Settings**](https://dashboard.clerk.com/~/billing/settings) page in the Clerk Dashboard. This page will guide you through enabling billing for your application.
3
+
To enable Billing for your application, navigate to the [**Billing Settings**](https://dashboard.clerk.com/~/billing/settings) page in the Clerk Dashboard. This page will guide you through enabling Billing for your application.
4
4
5
5
Clerk Billing costs the same as using Stripe Billing directly, just 0.7% per transaction, plus transaction fees which are paid directly to Stripe. Clerk Billing is **not** the same as Stripe Billing. Plans and pricing are managed directly through the Clerk Dashboard and won't sync with your existing Stripe products or plans. Clerk uses Stripe **only** for payment processing, so you don't need to set up Stripe Billing.
6
6
7
7
### Payment gateway
8
8
9
-
Once you have enabled billing, you will see the following **Payment gateway** options for collecting payments via Stripe:
9
+
Once you have enabled Billing, you will see the following **Payment gateway** options for collecting payments via Stripe:
10
10
11
-
-**Clerk development gateway**: A shared **test** Stripe account used for development instances. This allows developers to test and build billing flows **in development** without needing to create and configure a Stripe account.
11
+
-**Clerk development gateway**: A shared **test** Stripe account used for development instances. This allows developers to test and build Billing flows **in development** without needing to create and configure a Stripe account.
12
12
-**Stripe account**: Use your own Stripe account for production. **A Stripe account created for a development instance cannot be used for production**. You will need to create a separate Stripe account for your production environment.
Used to activate a specific [organization](/docs/guides/organizations/overview) or [personal account](/docs/guides/dashboard/overview) based on URL path parameters. If there's a mismatch between the [active organization](!active-organization) in the session (e.g., as reported by [`auth()`](/docs/reference/nextjs/app-router/auth)) and the organization indicated by the URL, the middleware will attempt to activate the organization specified in the URL.
49
+
Used to activate a specific [Organization](/docs/guides/organizations/overview) or [Personal Account](/docs/guides/dashboard/overview) based on URL path parameters. If there's a mismatch between the [Active Organization](!active-organization) in the session (e.g., as reported by [`auth()`](/docs/reference/nextjs/app-router/auth)) and the Organization indicated by the URL, the middleware will attempt to activate the Organization specified in the URL.
Copy file name to clipboardExpand all lines: docs/_partials/clerk-options.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,5 +86,5 @@
86
86
-`taskUrls?`
87
87
-`Record<SessionTask['key'], string>`
88
88
89
-
The URL paths users are redirected to after sign-up or sign-in when specific session tasks need to be completed. For example, `{ 'choose-organization': '/onboarding/choose-organization' }` redirects users to `/onboarding/choose-organization` after sign-up if they need to choose an organization.
89
+
The URL paths users are redirected to after sign-up or sign-in when specific session tasks need to be completed. For example, `{ 'choose-organization': '/onboarding/choose-organization' }` redirects users to `/onboarding/choose-organization` after sign-up if they need to choose an Organization.
> 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/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.
Copy file name to clipboardExpand all lines: docs/_partials/organization-sync-options.mdx
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,14 @@ object has the type `OrganizationSyncOptions`, which has the following propertie
5
5
-`organizationPatterns`
6
6
- <code>[Pattern](#pattern)\[]</code>
7
7
8
-
Specifies URL patterns that are organization-specific, containing an organization ID or slug as a path parameter. If a request
9
-
matches this path, the organization identifier will be used to set that org as active.
8
+
Specifies URL patterns that are Organization-specific, containing an Organization ID or slug as a path parameter. If a request matches this path, the Organization identifier will be used to set that Organization as active.
10
9
11
10
If the route also matches the `personalAccountPatterns` prop, this prop takes precedence.
12
11
13
-
Patterns must have a path parameter named either `:id` (to match a Clerk organization ID) or `:slug` (to match a Clerk organization slug).
12
+
Patterns must have a path parameter named either `:id` (to match a Clerk Organization ID) or `:slug` (to match a Clerk Organization slug).
14
13
15
14
> [!WARNING]
16
-
> If the organization can't be activated—either because it doesn't exist or the user lacks access—the previously [active organization](!active-organization) will remain unchanged. Components must detect this case and provide an appropriate error and/or resolution pathway, such as calling `notFound()` or displaying an [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher).
15
+
> If the Organization can't be activated—either because it doesn't exist or the user lacks access—the previously [Active Organization](!active-organization) will remain unchanged. Components must detect this case and provide an appropriate error and/or resolution pathway, such as calling `notFound()` or displaying an [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher).
17
16
18
17
Common examples:
19
18
@@ -26,7 +25,7 @@ object has the type `OrganizationSyncOptions`, which has the following propertie
26
25
-`personalAccountPatterns`
27
26
- <code>[Pattern](#pattern)\[]</code>
28
27
29
-
URL patterns for resources that exist within the context of a user's [personal account](/docs/guides/organizations/configure#enable-organizations).
28
+
URL patterns for resources that exist within the context of a user's [Personal Account](/docs/guides/organizations/configure#allow-personal-accounts).
30
29
31
30
If the route also matches the `organizationPattern` prop, the `organizationPattern` prop takes precedence.
A user can be a member of multiple organizations, but only one can be active at a time. The **active organization** determines which organization-specific data the user can access and which role and related permissions they have within the organization.
1
+
A user can be a member of multiple Organizations, but only one can be active at a time. The **Active Organization** determines which Organization-specific data the user can access and which Role and related Permissions they have within the Organization.
Copy file name to clipboardExpand all lines: docs/getting-started/core-concepts.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Clerk provides three ways to integrate authentication into your application, dep
13
13
1.**[Prebuilt components](/docs/reference/components/overview)**: All-in-one UI components that can be integrated into your application. They are fully customizable to match your application's branding and design. This is the recommended approach for most use cases.
14
14
1.**[Custom flows using the Clerk API](/docs/guides/development/custom-flows/overview)**: Build your own UI using the Clerk API. This option provides maximum flexibility and control over the user experience but requires more development effort.
15
15
16
-
Clerk offers a comprehensive suite of prebuilt components designed to seamlessly integrate authentication and multi-tenancy into your application. Components, like `<SignIn />`, `<UserButton />`, and `<OrganizationSwitcher />`, are all-in-one solutions that handle the full lifecycle of the user experience, from sign-up/sign-in to user profile and organization management.
16
+
Clerk offers a comprehensive suite of prebuilt components designed to seamlessly integrate authentication and multi-tenancy into your application. Components, like `<SignIn />`, `<UserButton />`, and `<OrganizationSwitcher />`, are all-in-one solutions that handle the full lifecycle of the user experience, from sign-up/sign-in to user profile and Organization management.
17
17
18
18
The Account Portal uses these components on dedicated pages that are hosted on Clerk servers. These pages cannot be customized beyond the options provided in the [Clerk Dashboard](https://dashboard.clerk.com/~/account-portal).
19
19
@@ -32,7 +32,7 @@ For example, you can:
32
32
33
33
- Enable phone number authentication or multi-factor authentication.
34
34
- Add social providers like Google.
35
-
- Delete users or create organizations.
35
+
- Delete users or create Organizations.
36
36
- Invite other users to your [workspace](/docs/guides/dashboard/overview#workspaces) to help configure and manage your application.
37
37
38
38
To get started, see the [configuration docs](/docs/guides/configure/auth-strategies/sign-up-sign-in-options), which include dedicated guides for specific configuration options.
@@ -67,9 +67,9 @@ The [`User`](/docs/reference/javascript/user) object represents the current user
67
67
68
68
#### Organization
69
69
70
-
Organizations are a flexible and scalable way to manage users and their access to resources within your Clerk application. With organizations, you can assign specific roles and permissions to users, making them useful for managing projects, coordinating teams, or facilitating partnerships.
70
+
Organizations are a flexible and scalable way to manage users and their access to resources within your Clerk application. With Organizations, you can assign specific Roles and Permissions to users, making them useful for managing projects, coordinating teams, or facilitating partnerships.
71
71
72
-
Users can belong to many organizations. One of them will be the [active organization](!active-organization) of the session. It is represented by the [`Organization`](/docs/reference/javascript/organization) object. To learn about organizations, see the [dedicated guide](/docs/guides/organizations/overview).
72
+
Users can belong to many Organizations. One of them will be the [Active Organization](!active-organization) of the session. It is represented by the [`Organization`](/docs/reference/javascript/organization) object. To learn about Organizations, see the [dedicated guide](/docs/guides/organizations/overview).
0 commit comments