-
Notifications
You must be signed in to change notification settings - Fork 889
Reorganize and restructure Organization docs #2758
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 67 commits
0280654
9f7ac66
8ca739d
884b852
f2ca024
be700f3
f58ef2a
019a616
27bb678
d734d2d
6913823
772f1d3
faec6dd
4de425d
0d288fb
ef57b7d
71713d2
b8fa177
0fa0ffc
66d4a08
6c0a1d0
755bf56
56b26e0
e0921ae
53018c5
6f50cbc
4853b4a
ee543a0
3e70777
9307abf
66daa0f
4017943
b720ae3
fa41ceb
8615550
606dacb
8a320bf
a22eff3
96bfc31
5f919bb
3b4294c
9c4dffa
534566a
4a10ebc
1875703
be87081
28395b7
85a739c
8f5ea07
9a6d925
b21e03a
a411070
fa64d14
6a4dadf
4caa01b
52bd170
6f92625
ed19aff
b40ac94
4bf0772
cf55d8c
aff5ac1
daeaf57
9076e33
8176513
6abd3a0
702653c
71202ff
fe9c8d9
472fa3f
f923717
506d44f
a6ad5a6
2a8afef
948c923
e500198
9b4e61c
5958351
3498c9f
63e88c1
cac288b
1f1ae5b
191a16a
9feec41
9cb6661
3cbd608
265d507
0ea241c
5feec1e
e2c0c83
ddfaf2c
995dcff
a790f0a
ab4f966
bc56de8
1232f9a
dec6386
04fb619
3685328
eb0b1c3
54eaac1
94e956d
abba5ba
50e7474
30da397
df7ce0c
69be299
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| `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). | ||
|
|
||
| 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. | ||
| 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. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| | Property | Type | Description | | ||
| | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <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> | | ||
| | <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> | | ||
| | <a id="invitations"></a> `invitations?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "pending" \| "accepted" \| "revoked")[]; \} & \{ 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> | | ||
| | <a id="membershiprequests"></a> `membershipRequests?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ 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> | | ||
| | <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> | |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| > [!WARNING] | ||
| > 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. | ||
| > 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. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This happens because the choose-organization session task must be completed before the user's authentication process can be considered complete. Session tasks are pending requirements that users must complete after authentication. Learn more about [session tasks](/docs/guides/configure/session-tasks). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,23 +6,23 @@ sdk: expo | |
|
|
||
| <TutorialHero | ||
| exampleRepo={[ | ||
| { | ||
| title: "Expo quickstart repo", | ||
| link: "https://github.com/clerk/clerk-expo-quickstart", | ||
| }, | ||
| ]} | ||
| { | ||
| title: "Expo quickstart repo", | ||
| link: "https://github.com/clerk/clerk-expo-quickstart", | ||
| }, | ||
| ]} | ||
| beforeYouStart={[ | ||
| { | ||
| title: "Set up a Clerk application", | ||
| link: "/docs/getting-started/quickstart/setup-clerk", | ||
| icon: "clerk", | ||
| }, | ||
| { | ||
| title: "Create an Expo app", | ||
| link: "https://docs.expo.dev/get-started/create-a-project/", | ||
| icon: "expo", | ||
| }, | ||
| ]} | ||
| { | ||
| title: "Set up a Clerk application", | ||
| link: "/docs/getting-started/quickstart/setup-clerk", | ||
| icon: "clerk", | ||
| }, | ||
| { | ||
| title: "Create an Expo app", | ||
| link: "https://docs.expo.dev/get-started/create-a-project/", | ||
| icon: "expo", | ||
| }, | ||
|
||
| ]} | ||
| /> | ||
|
|
||
| <Steps> | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.