diff --git a/clerk-typedoc/react/headless-browser-clerk.mdx b/clerk-typedoc/react/headless-browser-clerk.mdx index b873703742..858aa76528 100644 --- a/clerk-typedoc/react/headless-browser-clerk.mdx +++ b/clerk-typedoc/react/headless-browser-clerk.mdx @@ -81,6 +81,7 @@ Browser `Clerk` instance after `@clerk/clerk-js` loads. Extends [`Clerk`](/docs/ | `signOut` | \{ (options?: SignOutOptions): Promise\; (signOutCallback?: () => void \| Promise\, options?: SignOutOptions): Promise\; \} | Signs out the current user on single-session instances, or all users on multi-session instances. | | `status` | "error" \| "degraded" \| "loading" \| "ready" | The status of the `Clerk` instance. Possible values are: | | `telemetry` | undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \} | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. | +| `uiVersion` | undefined \| string | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. | | `unmountAPIKeys` | (targetNode: HTMLDivElement) => void | Unmount an API keys component from the target element. If there is no component mounted at the target node, results in a noop. | | `unmountCreateOrganization` | (targetNode: HTMLDivElement) => void | Unmount the CreateOrganization component from the target node. | | `unmountOAuthConsent` | (targetNode: HTMLDivElement) => void | Unmounts a OAuth consent component from the target element. | diff --git a/clerk-typedoc/react/plan-details-button.mdx b/clerk-typedoc/react/plan-details-button.mdx index 5c5ab65d5b..e26f5c78a9 100644 --- a/clerk-typedoc/react/plan-details-button.mdx +++ b/clerk-typedoc/react/plan-details-button.mdx @@ -1,5 +1,4 @@ -A button component that opens the Clerk Plan Details drawer when clicked. This component is part of -Clerk's Billing feature which is available under a public beta. +A button component that opens the Clerk Plan Details drawer when clicked. ## Parameters diff --git a/clerk-typedoc/shared/clerk/properties.mdx b/clerk-typedoc/shared/clerk/properties.mdx index 914cd9313f..0960bc01e5 100644 --- a/clerk-typedoc/shared/clerk/properties.mdx +++ b/clerk-typedoc/shared/clerk/properties.mdx @@ -9,7 +9,7 @@ | `isSignedIn` | `boolean` | Indicates whether the current user has a valid signed-in client session. | | `isStandardBrowser` | undefined \| boolean | Indicates whether the instance is being loaded in a standard browser environment. Set to `false` on native platforms where cookies cannot be set. When `undefined`, Clerk assumes a standard browser. | | `loaded` | `boolean` | Indicates whether the `Clerk` object is ready for use. Set to `false` when the `status` is `"loading"`. Set to `true` when the `status` is `"ready"` or `"degraded"`. | -| `oauthApplication` | [`OAuthApplicationNamespace`](../o-auth-application-namespace.mdx) | OAuth application helpers (e.g. consent metadata for custom consent UIs). | +| `oauthApplication` | [`OAuthApplicationNamespace`](/docs/reference/types/oauth-application) | OAuth application helpers (e.g. consent metadata for custom consent UIs). | | `organization` | undefined \| null \| [OrganizationResource](/docs/reference/objects/organization) | A shortcut to the last active `Session.user.organizationMemberships` which holds an instance of a `Organization` object. If the session is `null` or `undefined`, the user field will match. | | `proxyUrl` | undefined \| string | **Required for applications that run behind a reverse proxy**. Your Clerk app's proxy URL. Can be either a relative path (`/__clerk`) or a full URL (`https:///__clerk`). | | `publishableKey` | `string` | Your Clerk [Publishable Key](!publishable-key). | @@ -17,5 +17,6 @@ | `session` | undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session) | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. | | `status` | "error" \| "degraded" \| "loading" \| "ready" | The status of the `Clerk` instance. Possible values are: | | `telemetry` | undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \} | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. | +| `uiVersion` | undefined \| string | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. | | `user` | undefined \| null \| [UserResource](/docs/reference/objects/user) | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. | | `version` | undefined \| string | The Clerk SDK version number. | diff --git a/clerk-typedoc/shared/create-organization-domain-params.mdx b/clerk-typedoc/shared/create-organization-domain-params.mdx new file mode 100644 index 0000000000..438324b9a2 --- /dev/null +++ b/clerk-typedoc/shared/create-organization-domain-params.mdx @@ -0,0 +1,4 @@ +| Property | Type | Description | +| --------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `enrollmentMode?` | "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" \| "enterprise_sso" | The enrollment mode that determines how matching users are added to the Organization. Defaults to `manual_invitation`. | +| `name` | `string` | The domain name, for example `clerk.com`. | diff --git a/clerk-typedoc/shared/headless-browser-clerk.mdx b/clerk-typedoc/shared/headless-browser-clerk.mdx index 3cad73a769..b051d544d1 100644 --- a/clerk-typedoc/shared/headless-browser-clerk.mdx +++ b/clerk-typedoc/shared/headless-browser-clerk.mdx @@ -55,7 +55,7 @@ Browser `Clerk` instance after `@clerk/clerk-js` loads. Extends [`Clerk`](/docs/ | `mountUserProfile` | (targetNode: HTMLDivElement, userProfileProps?: [UserProfileProps](user-profile-props.mdx)) => void | Mount a user profile component at the target element. | | `mountWaitlist` | (targetNode: HTMLDivElement, props?: [WaitlistProps](waitlist-props.mdx)) => void | Mount a waitlist at the target element. | | `navigate` | [`CustomNavigation`](custom-navigation.mdx) | Helper method which will use the custom push navigation function of your application to navigate to the provided URL or relative path. Returns a promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within. | -| `oauthApplication` | [`OAuthApplicationNamespace`](o-auth-application-namespace.mdx) | OAuth application helpers (e.g. consent metadata for custom consent UIs). | +| `oauthApplication` | [`OAuthApplicationNamespace`](/docs/reference/types/oauth-application) | OAuth application helpers (e.g. consent metadata for custom consent UIs). | | `off` | [`OffEventListener`](off-event-listener.mdx) | Removes an event handler for a specific Clerk event. **Param** The event name to unsubscribe from **Param** The callback function to remove. | | `on` | [`OnEventListener`](on-event-listener.mdx) | Registers an event handler for a specific Clerk event. **Param** The event name to subscribe to. **Param** The callback function to execute when the event is triggered. **Param** An object to control the behavior of the event handler. If true, and the event was previously dispatched, handler will be called immediately with the latest payload. **Param** If `true` and the event was previously dispatched, the handler will be called immediately with the latest payload. | | `openCreateOrganization` | (props?: [CreateOrganizationModalProps](create-organization-modal-props.mdx)) => void | Opens the Clerk CreateOrganization modal. | @@ -81,6 +81,7 @@ Browser `Clerk` instance after `@clerk/clerk-js` loads. Extends [`Clerk`](/docs/ | `signOut` | \{ (options?: [SignOutOptions](sign-out-options.mdx)): Promise\; (signOutCallback?: () => void \| Promise\, options?: [SignOutOptions](sign-out-options.mdx)): Promise\; \} | Signs out the current user on single-session instances, or all users on multi-session instances. | | `status` | "error" \| "degraded" \| "loading" \| "ready" | The status of the `Clerk` instance. Possible values are: | | `telemetry` | undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \} | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. | +| `uiVersion` | undefined \| string | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. | | `unmountAPIKeys` | (targetNode: HTMLDivElement) => void | Unmount an API keys component from the target element. If there is no component mounted at the target node, results in a noop. | | `unmountCreateOrganization` | (targetNode: HTMLDivElement) => void | Unmount the CreateOrganization component from the target node. | | `unmountOAuthConsent` | (targetNode: HTMLDivElement) => void | Unmounts a OAuth consent component from the target element. | diff --git a/clerk-typedoc/shared/organization-domain-bulk-ownership-verification-error-json.mdx b/clerk-typedoc/shared/organization-domain-bulk-ownership-verification-error-json.mdx new file mode 100644 index 0000000000..4d666a0d6c --- /dev/null +++ b/clerk-typedoc/shared/organization-domain-bulk-ownership-verification-error-json.mdx @@ -0,0 +1,3 @@ +A per-domain failure entry returned by the bulk ownership verification +endpoints, carrying the `organization_domain_id` and the API error code that +caused it to be skipped. diff --git a/clerk-typedoc/shared/organization-domain-bulk-ownership-verification-error.mdx b/clerk-typedoc/shared/organization-domain-bulk-ownership-verification-error.mdx new file mode 100644 index 0000000000..548b85700b --- /dev/null +++ b/clerk-typedoc/shared/organization-domain-bulk-ownership-verification-error.mdx @@ -0,0 +1,10 @@ +A per-domain failure entry returned by the bulk ownership verification flows, +carrying the id of the domain that was skipped and the API error code that +caused it. + +## Properties + +| Property | Type | Description | +| ------------------------ | -------- | ------------------------------------------------------------------------------------------- | +| `code` | `string` | The API error code describing why the domain was skipped, for example `resource_not_found`. | +| `id` | `string` | The unique identifier of the Verified Domain that could not be processed. | diff --git a/clerk-typedoc/shared/organization-domain-ownership-verification.mdx b/clerk-typedoc/shared/organization-domain-ownership-verification.mdx new file mode 100644 index 0000000000..9f69d11b40 --- /dev/null +++ b/clerk-typedoc/shared/organization-domain-ownership-verification.mdx @@ -0,0 +1,14 @@ +Holds the ownership verification details of an Organization's domain, including +the TXT record an admin must publish to prove ownership. + +## Properties + +| Property | Type | Description | +| -------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `attempts` | null \| number | The number of verification attempts that have been made, or `null` if none. | +| `expiresAt` | null \| Date | The date and time when the current verification attempt expires, or `null`. | +| `status` | "unverified" \| "verified" | The current status of the domain ownership verification. | +| `strategy` | "txt" \| "legacy" \| "manual_override" | The strategy used to verify ownership of the domain. | +| `txtRecordName` | null \| string | The fully qualified DNS name the org admin must publish the TXT record under. Present only immediately after preparing ownership verification. | +| `txtRecordValue` | null \| string | The exact value the org admin must publish in the TXT record. Present only immediately after preparing ownership verification. | +| `verifiedAt` | null \| Date | The date and time when ownership of the domain was verified, or `null` if it has not been verified. | diff --git a/clerk-typedoc/shared/organization-domain-resource.mdx b/clerk-typedoc/shared/organization-domain-resource.mdx index c3a933062e..9b0d3dfd85 100644 --- a/clerk-typedoc/shared/organization-domain-resource.mdx +++ b/clerk-typedoc/shared/organization-domain-resource.mdx @@ -5,16 +5,18 @@ The `OrganizationDomain` object is the model around an Organization's [Verified | Property | Type | Description | | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `affiliationEmailAddress` | null \| string | The email address used to verify the affiliation with the domain, or `null` if none has been provided. | +| `affiliationVerification` | null \| [OrganizationDomainVerification](organization-domain-verification.mdx) | The affiliation verification details for the domain, or `null` if the domain has not been verified. | | `attemptAffiliationVerification` | (params: [AttemptAffiliationVerificationParams](attempt-affiliation-verification-params.mdx)) => Promise\ | Completes the affiliation verification flow by validating the code sent to the affiliation email address. | | `createdAt` | `Date` | The date and time when the domain was created. | | `delete` | () => Promise\ | Deletes the Verified Domain. | -| `enrollmentMode` | "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" | The enrollment mode that determines how matching users are added to the Organization. | +| `enrollmentMode` | "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" \| "enterprise_sso" | The enrollment mode that determines how matching users are added to the Organization. | | `id` | `string` | The unique identifier for the Verified Domain. | | `name` | `string` | The domain name, for example `clerk.com`. | | `organizationId` | `string` | The ID of the Organization that the Verified Domain belongs to. | +| `ownershipVerification` | null \| [OrganizationDomainOwnershipVerification](organization-domain-ownership-verification.mdx) | The ownership verification details for the domain, or `null` if ownership has not been verified. | | `prepareAffiliationVerification` | (params: [PrepareAffiliationVerificationParams](prepare-affiliation-verification-params.mdx)) => Promise\ | Begins the affiliation verification flow by sending a verification code to the provided email address. | | `totalPendingInvitations` | `number` | The total number of pending [invitations](/docs/reference/types/organization-invitation) associated with this domain. | | `totalPendingSuggestions` | `number` | The total number of pending [suggestions](/docs/reference/types/organization-suggestion) associated with this domain. | | `updatedAt` | `Date` | The date and time when the domain was last updated. | | `updateEnrollmentMode` | (params: [UpdateEnrollmentModeParams](update-enrollment-mode-params.mdx)) => Promise\ | Updates the enrollment mode of the Verified Domain. | -| `verification` | null \| [OrganizationDomainVerification](organization-domain-verification.mdx) | The verification details for the domain, or `null` if the domain has not been verified. | +| ~~`verification`~~ | null \| [OrganizationDomainVerification](organization-domain-verification.mdx) | The verification details for the domain, or `null` if the domain has not been verified. **Deprecated.** Use `affiliationVerification` instead. | diff --git a/clerk-typedoc/shared/organization-domains-bulk-ownership-verification-json.mdx b/clerk-typedoc/shared/organization-domains-bulk-ownership-verification-json.mdx new file mode 100644 index 0000000000..eb8c54a7b9 --- /dev/null +++ b/clerk-typedoc/shared/organization-domains-bulk-ownership-verification-json.mdx @@ -0,0 +1,3 @@ +Partial-success payload returned by the bulk `prepare`/`attempt` +ownership verification endpoints. Each requested domain id lands in either +`data` (with its current ownership state) or `errors`. diff --git a/clerk-typedoc/shared/organization-domains-bulk-ownership-verification-resource.mdx b/clerk-typedoc/shared/organization-domains-bulk-ownership-verification-resource.mdx new file mode 100644 index 0000000000..aa8f7cb7a7 --- /dev/null +++ b/clerk-typedoc/shared/organization-domains-bulk-ownership-verification-resource.mdx @@ -0,0 +1,11 @@ +The partial-success result of a bulk ownership verification flow +(`prepareOwnershipVerification`/`attemptOwnershipVerification`). Each +requested domain lands in either `data` (with its current ownership state) +or `errors`. + +## Properties + +| Property | Type | Description | +| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data` | [OrganizationDomainResource](/docs/reference/types/organization-domain-resource)[] | The Verified Domains that were processed successfully. After `prepareOwnershipVerification`, each domain's `ownershipVerification` carries the `txtRecordName` and `txtRecordValue` to publish. | +| `errors` | [OrganizationDomainBulkOwnershipVerificationError](organization-domain-bulk-ownership-verification-error.mdx)[] | The per-domain failures that were skipped without failing the whole batch. | diff --git a/clerk-typedoc/shared/organization-resource/methods/attempt-ownership-verification.mdx b/clerk-typedoc/shared/organization-resource/methods/attempt-ownership-verification.mdx new file mode 100644 index 0000000000..972142c763 --- /dev/null +++ b/clerk-typedoc/shared/organization-resource/methods/attempt-ownership-verification.mdx @@ -0,0 +1,18 @@ +### `attemptOwnershipVerification()` + +Resolves the published TXT record for each of the given domains in a single +request to complete ownership verification. A single bad domain does not +fail the batch; it lands in `errors`. + +Returns an [`OrganizationDomainsBulkOwnershipVerificationResource`](/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object. + +```typescript +function attemptOwnershipVerification(domainIds: string[]): Promise +``` + +#### Parameters + + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `domainIds` | string[] | The unique identifiers of the domains to attempt. | diff --git a/clerk-typedoc/shared/organization-resource/methods/create-domain.mdx b/clerk-typedoc/shared/organization-resource/methods/create-domain.mdx index 5d2f253743..0c10af26ad 100644 --- a/clerk-typedoc/shared/organization-resource/methods/create-domain.mdx +++ b/clerk-typedoc/shared/organization-resource/methods/create-domain.mdx @@ -8,7 +8,7 @@ Returns an [`OrganizationDomainResource`](/docs/reference/types/organization-dom > You must have [**Verified domains**](/docs/guides/organizations/add-members/verified-domains) enabled in your app's settings in the Clerk Dashboard. ```typescript -function createDomain(domainName: string): Promise +function createDomain(domainName: string, params?: Pick): Promise ``` #### Parameters @@ -17,3 +17,4 @@ function createDomain(domainName: string): Promise | Parameter | Type | Description | | ------ | ------ | ------ | | `domainName` | `string` | The name of the domain to create. | +| `params?` | `Pick`\<[`CreateOrganizationDomainParams`](#create-organization-domain-params), `"enrollmentMode"`\> | Optional parameters, including the `enrollmentMode` to assign to the new domain. | diff --git a/clerk-typedoc/shared/organization-resource/methods/get-domains.mdx b/clerk-typedoc/shared/organization-resource/methods/get-domains.mdx index ecb14a05ca..55927e595b 100644 --- a/clerk-typedoc/shared/organization-resource/methods/get-domains.mdx +++ b/clerk-typedoc/shared/organization-resource/methods/get-domains.mdx @@ -16,6 +16,6 @@ function getDomains(params?: GetDomainsParams): Promise"manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" | The [enrollment mode](/docs/guides/organizations/add-members/verified-domains#enable-verified-domains) will decide how new users join an organization. | +| `enrollmentMode?` | "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" \| "enterprise_sso" | The [enrollment mode](/docs/guides/organizations/add-members/verified-domains#enable-verified-domains) will decide how new users join an organization. | | `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. | | `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. | diff --git a/clerk-typedoc/shared/organization-resource/methods/prepare-ownership-verification.mdx b/clerk-typedoc/shared/organization-resource/methods/prepare-ownership-verification.mdx new file mode 100644 index 0000000000..f58f25cdb4 --- /dev/null +++ b/clerk-typedoc/shared/organization-resource/methods/prepare-ownership-verification.mdx @@ -0,0 +1,19 @@ +### `prepareOwnershipVerification()` + +Issues a fresh TXT challenge for each of the given domains in a single +request. Each resolved domain's `ownershipVerification` carries the +`txtRecordName` and `txtRecordValue` the org admin must publish. A single +bad domain does not fail the batch; it lands in `errors`. + +Returns an [`OrganizationDomainsBulkOwnershipVerificationResource`](/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object. + +```typescript +function prepareOwnershipVerification(domainIds: string[]): Promise +``` + +#### Parameters + + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `domainIds` | string[] | The unique identifiers of the domains to prepare. | diff --git a/clerk-typedoc/shared/organization-resource/properties.mdx b/clerk-typedoc/shared/organization-resource/properties.mdx index e2c97087b4..b32fefc41d 100644 --- a/clerk-typedoc/shared/organization-resource/properties.mdx +++ b/clerk-typedoc/shared/organization-resource/properties.mdx @@ -2,6 +2,7 @@ | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `adminDeleteEnabled` | `boolean` | Whether the Organization allows admins to delete users. | | `createdAt` | `Date` | The date when the Organization was first created. | +| `exclusiveMembership` | `boolean` | Whether the Organization enforces exclusive membership, meaning members must have it set as their active Organization. Defaults to `false` for instances that have not adopted the feature. | | `hasImage` | `boolean` | Whether the Organization has an image. | | `id` | `string` | The unique identifier for the Organization. | | `imageUrl` | `string` | Holds the Organization's logo. Compatible with Clerk's [Image Optimization](/docs/guides/development/image-optimization). | diff --git a/clerk-typedoc/shared/organization-settings-resource.mdx b/clerk-typedoc/shared/organization-settings-resource.mdx index 1872dff09b..3510dec9c7 100644 --- a/clerk-typedoc/shared/organization-settings-resource.mdx +++ b/clerk-typedoc/shared/organization-settings-resource.mdx @@ -2,19 +2,19 @@ The `OrganizationSettings` object holds the Organization-related settings config ## Properties -| Property | Type | Description | -| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actions` | \{ adminDelete: boolean; \} | The Organization-related actions that are enabled for the instance. | -| `actions.adminDelete` | `boolean` | Whether admins are allowed to delete Organizations. | -| `domains` | \{ defaultRole: null \| string; enabled: boolean; enrollmentModes: ("manual_invitation" \| "automatic_invitation" \| "automatic_suggestion")[]; \} | The settings that control Organization [Verified Domains](/docs/guides/organizations/add-members/verified-domains) and member enrollment. | -| `domains.defaultRole` | null \| string | The default Role assigned to users enrolled through a domain, or `null` if there is none. | -| `domains.enabled` | `boolean` | Whether Verified Domains are enabled. | -| `domains.enrollmentModes` | ("manual_invitation" \| "automatic_invitation" \| "automatic_suggestion")[] | The enrollment modes that are available for Verified Domains.
  • `manual_invitation`: No automatic enrollment. Users with a matching email domain are not given any [invitation](/docs/guides/organizations/add-members/verified-domains#automatic-invitations) or [suggestion](/docs/guides/organizations/add-members/verified-domains#automatic-suggestions); an admin must invite them manually.
  • `automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](/docs/reference/types/organization-invitation) (assigned the Organization's default role) which they can accept to join.
  • `automatic_suggestion`: Users with a matching email domain automatically receive a [suggestion](/docs/guides/organizations/add-members/verified-domains#automatic-suggestions) to join, which they can request.
| -| `enabled` | `boolean` | Whether Organizations are enabled for the instance. | -| `forceOrganizationSelection` | `boolean` | Whether users are required to select an Organization after signing in. | -| `id?` | `string` | The unique identifier of the resource. | -| `maxAllowedMemberships` | `number` | The maximum number of memberships allowed per Organization. | -| `organizationCreationDefaults` | \{ enabled: boolean; \} | The settings that control the defaults used when creating an Organization. | -| `organizationCreationDefaults.enabled` | `boolean` | Whether Organization creation defaults are enabled. | -| `slug` | \{ disabled: boolean; \} | The settings that control Organization slugs. | -| `slug.disabled` | `boolean` | Whether Organization slugs are disabled. | +| Property | Type | Description | +| ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `actions` | \{ adminDelete: boolean; \} | The Organization-related actions that are enabled for the instance. | +| `actions.adminDelete` | `boolean` | Whether admins are allowed to delete Organizations. | +| `domains` | \{ defaultRole: null \| string; enabled: boolean; enrollmentModes: ("manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" \| "enterprise_sso")[]; \} | The settings that control Organization [Verified Domains](/docs/guides/organizations/add-members/verified-domains) and member enrollment. | +| `domains.defaultRole` | null \| string | The default Role assigned to users enrolled through a domain, or `null` if there is none. | +| `domains.enabled` | `boolean` | Whether Verified Domains are enabled. | +| `domains.enrollmentModes` | ("manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" \| "enterprise_sso")[] | The enrollment modes that are available for Verified Domains.
  • `manual_invitation`: No automatic enrollment. Users with a matching email domain are not given any [invitation](/docs/guides/organizations/add-members/verified-domains#automatic-invitations) or [suggestion](/docs/guides/organizations/add-members/verified-domains#automatic-suggestions); an admin must invite them manually.
  • `automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](/docs/reference/types/organization-invitation) (assigned the Organization's default role) which they can accept to join.
  • `automatic_suggestion`: Users with a matching email domain automatically receive a [suggestion](/docs/guides/organizations/add-members/verified-domains#automatic-suggestions) to join, which they can request.
| +| `enabled` | `boolean` | Whether Organizations are enabled for the instance. | +| `forceOrganizationSelection` | `boolean` | Whether users are required to select an Organization after signing in. | +| `id?` | `string` | The unique identifier of the resource. | +| `maxAllowedMemberships` | `number` | The maximum number of memberships allowed per Organization. | +| `organizationCreationDefaults` | \{ enabled: boolean; \} | The settings that control the defaults used when creating an Organization. | +| `organizationCreationDefaults.enabled` | `boolean` | Whether Organization creation defaults are enabled. | +| `slug` | \{ disabled: boolean; \} | The settings that control Organization slugs. | +| `slug.disabled` | `boolean` | Whether Organization slugs are disabled. | diff --git a/clerk-typedoc/shared/sign-in-future-create-params.mdx b/clerk-typedoc/shared/sign-in-future-create-params.mdx index 72241d5983..2175a0d6ea 100644 --- a/clerk-typedoc/shared/sign-in-future-create-params.mdx +++ b/clerk-typedoc/shared/sign-in-future-create-params.mdx @@ -7,6 +7,6 @@ | `password?` | `string` | The user's password. Only supported if [password](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#password) is enabled. | | `redirectUrl?` | `string` | The full URL or path that the OAuth provider should redirect to after successful authorization on their part. | | `signUpIfMissing?` | `boolean` | When set to `true`, if a user does not exist, the sign-up will prepare a transfer to sign up a new account. If bot sign-up protection is enabled, captcha will also be required on sign in. | -| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "passkey" \| "enterprise_sso" \| "ticket" | The first factor verification strategy to use in the sign-in flow. Depends on the `identifier` value. Each authentication identifier supports different verification strategies. | +| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "enterprise_sso" \| "passkey" \| "ticket" | The first factor verification strategy to use in the sign-in flow. Depends on the `identifier` value. Each authentication identifier supports different verification strategies. | | `ticket?` | `string` | **Required** if `strategy` is set to `'ticket'`. The [ticket _or token_](/docs/guides/development/custom-flows/authentication/application-invitations) generated from the Backend API. | | `transfer?` | `boolean` | When set to `true`, the `SignIn` will attempt to retrieve information from the active `SignUp` instance and use it to complete the sign-in process. This is useful when you want to seamlessly transition a user from a sign-up attempt to a sign-in attempt. | diff --git a/clerk-typedoc/shared/sign-in-future-resource/methods/create.mdx b/clerk-typedoc/shared/sign-in-future-resource/methods/create.mdx index c4268af285..30830cc829 100644 --- a/clerk-typedoc/shared/sign-in-future-resource/methods/create.mdx +++ b/clerk-typedoc/shared/sign-in-future-resource/methods/create.mdx @@ -23,6 +23,6 @@ function create(params: SignInFutureCreateParams): Promise<{ error: null | Clerk | `password?` | `string` | The user's password. Only supported if [password](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#password) is enabled. | | `redirectUrl?` | `string` | The full URL or path that the OAuth provider should redirect to after successful authorization on their part. | | `signUpIfMissing?` | `boolean` | When set to `true`, if a user does not exist, the sign-up will prepare a transfer to sign up a new account. If bot sign-up protection is enabled, captcha will also be required on sign in. | -| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "passkey" \| "enterprise_sso" \| "ticket" | The first factor verification strategy to use in the sign-in flow. Depends on the `identifier` value. Each authentication identifier supports different verification strategies. | +| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "enterprise_sso" \| "passkey" \| "ticket" | The first factor verification strategy to use in the sign-in flow. Depends on the `identifier` value. Each authentication identifier supports different verification strategies. | | `ticket?` | `string` | **Required** if `strategy` is set to `'ticket'`. The [ticket _or token_](/docs/guides/development/custom-flows/authentication/application-invitations) generated from the Backend API. | | `transfer?` | `boolean` | When set to `true`, the `SignIn` will attempt to retrieve information from the active `SignUp` instance and use it to complete the sign-in process. This is useful when you want to seamlessly transition a user from a sign-up attempt to a sign-in attempt. | diff --git a/clerk-typedoc/shared/sign-up-future-create-params.mdx b/clerk-typedoc/shared/sign-up-future-create-params.mdx index 491fe7df11..880fd6edd6 100644 --- a/clerk-typedoc/shared/sign-up-future-create-params.mdx +++ b/clerk-typedoc/shared/sign-up-future-create-params.mdx @@ -9,7 +9,7 @@ | `locale?` | `string` | The locale to assign to the user in [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) format (e.g., "en-US", "fr-FR"). If omitted, defaults to the browser's locale. | | `password?` | `string` | The user's password. [Password](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#password) must be enabled in the instance settings. | | `phoneNumber?` | `string` | The user's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). Only supported if [phone number](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#phone) is enabled in the instance settings. Keep in mind that the phone number requires an extra verification process. | -| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "phone_code" \| "enterprise_sso" \| "ticket" \| "google_one_tap" \| "oauth_token_apple" | The strategy to use for the sign-up. The following strategies are supported:
  • `'oauth_'`: The user will be authenticated with their [social connection account](/docs/guides/configure/auth-strategies/social-connections/overview). See a list of [supported values for ``](/docs/reference/types/sso).
  • `'enterprise_sso'`: The user will be authenticated either through SAML or OIDC depending on the configuration of their [enterprise SSO account](/docs/guides/configure/auth-strategies/enterprise-connections/overview).
  • `'ticket'`: The user will be authenticated via the ticket _or token_ generated from the Backend API.
  • `'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](/docs/reference/components/authentication/google-one-tap#authenticate-with-google-one-tap) instead, as it will also set the user's current session as active for you.
  • `'oauth_token_apple'`: The user will be authenticated using a native [Sign in with Apple](/docs/guides/configure/auth-strategies/sign-in-with-apple) identity token.
  • `'phone_code'`: The user will receive a one-time code via SMS to verify their phone number.
| +| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "enterprise_sso" \| "phone_code" \| "ticket" \| "google_one_tap" \| "oauth_token_apple" | The strategy to use for the sign-up. The following strategies are supported:
  • `'oauth_'`: The user will be authenticated with their [social connection account](/docs/guides/configure/auth-strategies/social-connections/overview). See a list of [supported values for ``](/docs/reference/types/sso).
  • `'enterprise_sso'`: The user will be authenticated either through SAML or OIDC depending on the configuration of their [enterprise SSO account](/docs/guides/configure/auth-strategies/enterprise-connections/overview).
  • `'ticket'`: The user will be authenticated via the ticket _or token_ generated from the Backend API.
  • `'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](/docs/reference/components/authentication/google-one-tap#authenticate-with-google-one-tap) instead, as it will also set the user's current session as active for you.
  • `'oauth_token_apple'`: The user will be authenticated using a native [Sign in with Apple](/docs/guides/configure/auth-strategies/sign-in-with-apple) identity token.
  • `'phone_code'`: The user will receive a one-time code via SMS to verify their phone number.
| | `ticket?` | `string` | **Required** if `strategy` is set to `'ticket'`. The [ticket _or token_](/docs/guides/development/custom-flows/authentication/application-invitations) generated from the Backend API. | | `transfer?` | `boolean` | When set to `true`, the `SignUp` will attempt to retrieve information from the active `SignIn` instance and use it to complete the sign-up process. This is useful when you want to seamlessly transition a user from a sign-in attempt to a sign-up attempt. | | `unsafeMetadata?` | [SignUpUnsafeMetadata](/docs/reference/types/metadata#sign-up-unsafe-metadata) | Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object. | diff --git a/clerk-typedoc/shared/sign-up-future-resource/methods/create.mdx b/clerk-typedoc/shared/sign-up-future-resource/methods/create.mdx index cea0d3fba5..20034ab9fb 100644 --- a/clerk-typedoc/shared/sign-up-future-resource/methods/create.mdx +++ b/clerk-typedoc/shared/sign-up-future-resource/methods/create.mdx @@ -25,7 +25,7 @@ function create(params: SignUpFutureCreateParams): Promise<{ error: null | Clerk | `locale?` | `string` | The locale to assign to the user in [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) format (e.g., "en-US", "fr-FR"). If omitted, defaults to the browser's locale. | | `password?` | `string` | The user's password. [Password](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#password) must be enabled in the instance settings. | | `phoneNumber?` | `string` | The user's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). Only supported if [phone number](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#phone) is enabled in the instance settings. Keep in mind that the phone number requires an extra verification process. | -| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "phone_code" \| "enterprise_sso" \| "ticket" \| "google_one_tap" \| "oauth_token_apple" | The strategy to use for the sign-up. The following strategies are supported:
  • `'oauth_'`: The user will be authenticated with their [social connection account](/docs/guides/configure/auth-strategies/social-connections/overview). See a list of [supported values for ``](/docs/reference/types/sso).
  • `'enterprise_sso'`: The user will be authenticated either through SAML or OIDC depending on the configuration of their [enterprise SSO account](/docs/guides/configure/auth-strategies/enterprise-connections/overview).
  • `'ticket'`: The user will be authenticated via the ticket _or token_ generated from the Backend API.
  • `'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](/docs/reference/components/authentication/google-one-tap#authenticate-with-google-one-tap) instead, as it will also set the user's current session as active for you.
  • `'oauth_token_apple'`: The user will be authenticated using a native [Sign in with Apple](/docs/guides/configure/auth-strategies/sign-in-with-apple) identity token.
  • `'phone_code'`: The user will receive a one-time code via SMS to verify their phone number.
| +| `strategy?` | [OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "enterprise_sso" \| "phone_code" \| "ticket" \| "google_one_tap" \| "oauth_token_apple" | The strategy to use for the sign-up. The following strategies are supported:
  • `'oauth_'`: The user will be authenticated with their [social connection account](/docs/guides/configure/auth-strategies/social-connections/overview). See a list of [supported values for ``](/docs/reference/types/sso).
  • `'enterprise_sso'`: The user will be authenticated either through SAML or OIDC depending on the configuration of their [enterprise SSO account](/docs/guides/configure/auth-strategies/enterprise-connections/overview).
  • `'ticket'`: The user will be authenticated via the ticket _or token_ generated from the Backend API.
  • `'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](/docs/reference/components/authentication/google-one-tap#authenticate-with-google-one-tap) instead, as it will also set the user's current session as active for you.
  • `'oauth_token_apple'`: The user will be authenticated using a native [Sign in with Apple](/docs/guides/configure/auth-strategies/sign-in-with-apple) identity token.
  • `'phone_code'`: The user will receive a one-time code via SMS to verify their phone number.
| | `ticket?` | `string` | **Required** if `strategy` is set to `'ticket'`. The [ticket _or token_](/docs/guides/development/custom-flows/authentication/application-invitations) generated from the Backend API. | | `transfer?` | `boolean` | When set to `true`, the `SignUp` will attempt to retrieve information from the active `SignIn` instance and use it to complete the sign-up process. This is useful when you want to seamlessly transition a user from a sign-in attempt to a sign-up attempt. | | `unsafeMetadata?` | [SignUpUnsafeMetadata](/docs/reference/types/metadata#sign-up-unsafe-metadata) | Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object. | diff --git a/clerk-typedoc/shared/sign-up-future-resource/properties.mdx b/clerk-typedoc/shared/sign-up-future-resource/properties.mdx index b56a6f2b61..433ab9d443 100644 --- a/clerk-typedoc/shared/sign-up-future-resource/properties.mdx +++ b/clerk-typedoc/shared/sign-up-future-resource/properties.mdx @@ -13,12 +13,12 @@ | `lastName` | null \| string | The `lastName` supplied to the current sign-up. Only supported if [First and last name](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#user-model) is enabled in the instance settings. | | `legalAcceptedAt` | null \| number | The epoch numerical time when the user agreed to the [legal compliance](/docs/guides/secure/legal-compliance) documents. | | `locale` | null \| string | The locale of the user in [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) format (e.g., "en-US", "fr-FR"), or `null` if not set. | -| `missingFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "password" \| "email_address" \| "phone_number" \| "username" \| "first_name" \| "last_name" \| "web3_wallet" \| "enterprise_sso" \| "legal_accepted" \| "email_address_or_phone_number")[] | An array of all the fields whose values are not supplied yet but they are mandatory in order for a sign-up to be marked as complete. | -| `optionalFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "password" \| "email_address" \| "phone_number" \| "username" \| "first_name" \| "last_name" \| "web3_wallet" \| "enterprise_sso" \| "legal_accepted" \| "email_address_or_phone_number")[] | An array of all the fields that can be supplied to the sign-up, but their absence does not prevent the sign-up from being marked as complete. | +| `missingFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "password" \| "enterprise_sso" \| "email_address" \| "phone_number" \| "username" \| "first_name" \| "last_name" \| "web3_wallet" \| "legal_accepted" \| "email_address_or_phone_number")[] | An array of all the fields whose values are not supplied yet but they are mandatory in order for a sign-up to be marked as complete. | +| `optionalFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "password" \| "enterprise_sso" \| "email_address" \| "phone_number" \| "username" \| "first_name" \| "last_name" \| "web3_wallet" \| "legal_accepted" \| "email_address_or_phone_number")[] | An array of all the fields that can be supplied to the sign-up, but their absence does not prevent the sign-up from being marked as complete. | | `phoneNumber` | null \| string | The `phoneNumber` supplied to the current sign-up in E.164 format. Only supported if [phone number](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#phone) is enabled in the instance settings. | -| `requiredFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "password" \| "email_address" \| "phone_number" \| "username" \| "first_name" \| "last_name" \| "web3_wallet" \| "enterprise_sso" \| "legal_accepted" \| "email_address_or_phone_number")[] | An array of all the required fields that need to be supplied and verified in order for this sign-up to be marked as complete and converted into a user. | +| `requiredFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "password" \| "enterprise_sso" \| "email_address" \| "phone_number" \| "username" \| "first_name" \| "last_name" \| "web3_wallet" \| "legal_accepted" \| "email_address_or_phone_number")[] | An array of all the required fields that need to be supplied and verified in order for this sign-up to be marked as complete and converted into a user. | | `status` | "complete" \| "abandoned" \| "missing_requirements" | The status of the current sign-up. | | `unsafeMetadata` | [SignUpUnsafeMetadata](/docs/reference/types/metadata#sign-up-unsafe-metadata) | Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object. | -| `unverifiedFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "email_address" \| "phone_number" \| "username" \| "web3_wallet" \| "enterprise_sso" \| "email_address_or_phone_number")[] | An array of all the fields whose values have been supplied, but they need additional verification in order for them to be accepted. Examples of such fields are `email_address` and `phone_number`. | +| `unverifiedFields` | ([OAuthStrategy](/docs/reference/types/sso#o-auth-strategy) \| "enterprise_sso" \| "email_address" \| "phone_number" \| "username" \| "web3_wallet" \| "email_address_or_phone_number")[] | An array of all the fields whose values have been supplied, but they need additional verification in order for them to be accepted. Examples of such fields are `email_address` and `phone_number`. | | `username` | null \| string | The `username` supplied to the current sign-up. Only supported if [username](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#username) is enabled in the instance settings. | | `web3Wallet` | null \| string | The Web3 wallet address supplied to the current sign-up, made up of 0x + 40 hexadecimal characters. Only supported if [Web3 authentication](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#web3-authentication) is enabled in the instance settings. | diff --git a/clerk-typedoc/shared/use-organization-params.mdx b/clerk-typedoc/shared/use-organization-params.mdx index 2dc0495471..a70e45d349 100644 --- a/clerk-typedoc/shared/use-organization-params.mdx +++ b/clerk-typedoc/shared/use-organization-params.mdx @@ -1,6 +1,6 @@ -| Property | Type | Description | -| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `domains?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/add-members/verified-domains#enable-verified-domains).
  • Any of the properties described in [Shared properties](#shared-properties).
| -| `invitations?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "pending" \| "accepted" \| "revoked")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the invitations by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| -| `membershipRequests?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the membership requests by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| -| `memberships?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ query?: string; role?: string[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `role`: An array of [`OrganizationCustomRoleKey`](/docs/reference/types/organization-custom-role-key).
  • `query`: A string that filters the memberships by the provided string.
  • Any of the properties described in [Shared properties](#shared-properties).
| +| Property | Type | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `domains?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion" \| "enterprise_sso"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/add-members/verified-domains#enable-verified-domains).
  • Any of the properties described in [Shared properties](#shared-properties).
| +| `invitations?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "pending" \| "accepted" \| "revoked")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the invitations by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| +| `membershipRequests?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the membership requests by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| +| `memberships?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ query?: string; role?: string[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `role`: An array of [`OrganizationCustomRoleKey`](/docs/reference/types/organization-custom-role-key).
  • `query`: A string that filters the memberships by the provided string.
  • Any of the properties described in [Shared properties](#shared-properties).
| diff --git a/docs/reference/objects/organization.mdx b/docs/reference/objects/organization.mdx index b670ca06d2..f4e700b4eb 100644 --- a/docs/reference/objects/organization.mdx +++ b/docs/reference/objects/organization.mdx @@ -151,6 +151,10 @@ To use these methods, you must have the **Organizations** feature [enabled in yo +## `createOrganizationDomainParams` + + + diff --git a/scripts/build-docs.ts b/scripts/build-docs.ts index eef59dc09d..fb0681e0f6 100644 --- a/scripts/build-docs.ts +++ b/scripts/build-docs.ts @@ -197,7 +197,10 @@ async function main() { 'guides/development/webhooks/inngest.mdx': ['doc-not-in-manifest'], 'guides/development/webhooks/loops.mdx': ['doc-not-in-manifest'], }, - typedoc: {}, + typedoc: { + 'shared/organization-resource/methods/attempt-ownership-verification.mdx': ['link-doc-not-found'], + 'shared/organization-resource/methods/prepare-ownership-verification.mdx': ['link-doc-not-found'], + }, partials: {}, tooltips: {}, },