diff --git a/clerk-typedoc/backend/enterprise-account-connection.mdx b/clerk-typedoc/backend/enterprise-account-connection.mdx index fe9246d885..d2e07b9bc9 100644 --- a/clerk-typedoc/backend/enterprise-account-connection.mdx +++ b/clerk-typedoc/backend/enterprise-account-connection.mdx @@ -1,4 +1,4 @@ -Represents an enterprise SSO connection associated with an enterprise account. +The Backend `EnterpriseAccountConnection` object represents an enterprise SSO connection associated with an enterprise account. ## Properties diff --git a/clerk-typedoc/backend/enterprise-connection-oauth-config.mdx b/clerk-typedoc/backend/enterprise-connection-oauth-config.mdx index e24bfd6911..715a97be8b 100644 --- a/clerk-typedoc/backend/enterprise-connection-oauth-config.mdx +++ b/clerk-typedoc/backend/enterprise-connection-oauth-config.mdx @@ -1,4 +1,4 @@ -OAuth configuration included on a Backend API [EnterpriseConnection](enterprise-connection.mdx) response. +OAuth configuration included on a Backend API [EnterpriseConnection](/docs/reference/backend/types/backend-enterprise-connection) response. ## Properties diff --git a/clerk-typedoc/backend/enterprise-connection-saml-connection.mdx b/clerk-typedoc/backend/enterprise-connection-saml-connection.mdx new file mode 100644 index 0000000000..9def79bac9 --- /dev/null +++ b/clerk-typedoc/backend/enterprise-connection-saml-connection.mdx @@ -0,0 +1,19 @@ +The Backend `EnterpriseConnectionSamlConnection` object holds information about a SAML enterprise connection for an instance or organization. + +## Properties + +| Property | Type | Description | +| ---------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| `acsUrl` | `string` | The Assertion Consumer Service (ACS) URL of the connection. | +| `allowIdpInitiated` | `boolean` | Indicates whether Identity Provider (IdP) initiated flows are allowed. | +| `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection. | +| `id` | `string` | The unique identifier for the SAML connection. | +| `idpCertificate` | `string` | The X.509 certificate as provided by the Identity Provider (IdP). | +| `idpEntityId` | `string` | The Entity ID as provided by the Identity Provider (IdP). | +| `idpMetadata` | `string` | The XML content of the Identity Provider (IdP) metadata file. | +| `idpMetadataUrl` | `string` | The URL which serves the Identity Provider (IdP) metadata. | +| `idpSsoUrl` | `string` | The Single-Sign On URL as provided by the Identity Provider (IdP). | +| `name` | `string` | The name to use as a label for the connection. | +| `spEntityId` | `string` | The Entity ID as provided by the Service Provider (Clerk). | +| `spMetadataUrl` | `string` | The metadata URL as provided by the Service Provider (Clerk). | +| `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk. | diff --git a/clerk-typedoc/backend/enterprise-connection.mdx b/clerk-typedoc/backend/enterprise-connection.mdx index 0ed14901b8..d3a92c90c5 100644 --- a/clerk-typedoc/backend/enterprise-connection.mdx +++ b/clerk-typedoc/backend/enterprise-connection.mdx @@ -2,17 +2,17 @@ The Backend `EnterpriseConnection` object holds information about an enterprise ## Properties -| Property | Type | Description | -| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `active` | `boolean` | Indicates whether the connection is active or not. | -| `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection or not. | -| `createdAt` | `number` | The date when the connection was first created. | -| `disableAdditionalIdentifications` | `boolean` | Indicates whether additional identifications are disabled for this connection. | -| `domains` | string[] | The domain of the enterprise. Sign-in flows using an email with this domain may use the connection. | -| `id` | `string` | The unique identifier for the connection. | -| `name` | `string` | The name to use as a label for the connection. | -| `oauthConfig` | null \| [EnterpriseConnectionOauthConfig](enterprise-connection-oauth-config.mdx) | OAuth (OIDC) configuration when the enterprise connection uses OAuth. | -| `organizationId` | null \| string | The Organization ID if the connection is scoped to an organization. | -| `samlConnection` | null \| EnterpriseConnectionSamlConnection | SAML connection details when the enterprise connection uses SAML. | -| `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk or not. | -| `updatedAt` | `number` | The date when the connection was last updated. | +| Property | Type | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `active` | `boolean` | Indicates whether the connection is active or not. | +| `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection or not. | +| `createdAt` | `number` | The date when the connection was first created. | +| `disableAdditionalIdentifications` | `boolean` | Indicates whether additional identifications are disabled for this connection. | +| `domains` | string[] | The domain of the enterprise. Sign-in flows using an email with this domain may use the connection. | +| `id` | `string` | The unique identifier for the connection. | +| `name` | `string` | The name to use as a label for the connection. | +| `oauthConfig` | null \| [EnterpriseConnectionOauthConfig](/docs/reference/backend/types/backend-enterprise-connection-oauth-config) | OAuth (OIDC) configuration when the enterprise connection uses OAuth. | +| `organizationId` | null \| string | The Organization ID if the connection is scoped to an organization. | +| `samlConnection` | null \| [EnterpriseConnectionSamlConnection](/docs/reference/backend/types/backend-enterprise-connection-saml-connection) | SAML connection details when the enterprise connection uses SAML. | +| `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk or not. | +| `updatedAt` | `number` | The date when the connection was last updated. | diff --git a/clerk-typedoc/react/configure-sso-params.mdx b/clerk-typedoc/react/configure-sso-params.mdx new file mode 100644 index 0000000000..30caf5e222 --- /dev/null +++ b/clerk-typedoc/react/configure-sso-params.mdx @@ -0,0 +1,5 @@ +## Parameters + +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | \ No newline at end of file diff --git a/clerk-typedoc/react/configure-sso-return.mdx b/clerk-typedoc/react/configure-sso-return.mdx new file mode 100644 index 0000000000..15f19e09d6 --- /dev/null +++ b/clerk-typedoc/react/configure-sso-return.mdx @@ -0,0 +1,7 @@ +## Returns + +null \| Element + +| Name | Type | +| -------------------------------------- | -------- | +| `displayName` | `string` | \ No newline at end of file diff --git a/clerk-typedoc/react/configure-sso.mdx b/clerk-typedoc/react/configure-sso.mdx new file mode 100644 index 0000000000..4e7c1192d0 --- /dev/null +++ b/clerk-typedoc/react/configure-sso.mdx @@ -0,0 +1,13 @@ +## Parameters + +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | + +## Returns + +null \| Element + +| Name | Type | +| -------------------------------------- | -------- | +| `displayName` | `string` | diff --git a/clerk-typedoc/react/use-o-auth-consent-params.mdx b/clerk-typedoc/react/use-o-auth-consent-params.mdx new file mode 100644 index 0000000000..0e63fb88b6 --- /dev/null +++ b/clerk-typedoc/react/use-o-auth-consent-params.mdx @@ -0,0 +1,5 @@ +## Parameters + +| Parameter | Type | +| --------- | ----------------------- | +| `params` | `UseOAuthConsentParams` | \ No newline at end of file diff --git a/clerk-typedoc/react/use-o-auth-consent-return.mdx b/clerk-typedoc/react/use-o-auth-consent-return.mdx new file mode 100644 index 0000000000..9b55f339dc --- /dev/null +++ b/clerk-typedoc/react/use-o-auth-consent-return.mdx @@ -0,0 +1,3 @@ +## Returns + +`UseOAuthConsentReturn` \ No newline at end of file diff --git a/clerk-typedoc/react/use-o-auth-consent.mdx b/clerk-typedoc/react/use-o-auth-consent.mdx new file mode 100644 index 0000000000..2ff9f61b33 --- /dev/null +++ b/clerk-typedoc/react/use-o-auth-consent.mdx @@ -0,0 +1,24 @@ +The `useOAuthConsent()` hook loads OAuth application consent metadata for the **signed-in** user +(`GET /me/oauth/consent/{oauthClientId}`). Ensure the user is authenticated before relying on this hook +(for example, redirect to sign-in on your custom consent route). + +## Parameters + +| Parameter | Type | +| --------- | ----------------------- | +| `params` | `UseOAuthConsentParams` | + +## Returns + +`UseOAuthConsentReturn` + +## Example + +```tsx +import { useOAuthConsent } from "@clerk/react/internal"; + +const { data, isLoading, error } = useOAuthConsent({ + oauthClientId: clientIdFromProps, + scope: scopeFromProps, +}); +``` diff --git a/clerk-typedoc/shared/clerk.mdx b/clerk-typedoc/shared/clerk.mdx index f8101ab61f..3bf24b0c05 100644 --- a/clerk-typedoc/shared/clerk.mdx +++ b/clerk-typedoc/shared/clerk.mdx @@ -5,7 +5,9 @@ Main Clerk SDK object. | Property | Type | Description | | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `__experimental_checkout` | `__experimental_CheckoutFunction` | Checkout API | +| `__experimental_mountConfigureSSO` | (targetNode: HTMLDivElement, props?: [\_\_experimental_ConfigureSSOProps](experimental_configure-sso-props.mdx)) => void | Mount a configure SSO component at the target element. | | `__experimental_prefetchOrganizationSwitcher` | () => void | Prefetches the data displayed by an Organization switcher. It can be used when `mountOrganizationSwitcher({ asStandalone: true})`, to avoid unwanted loading states. | +| `__experimental_unmountConfigureSSO` | (targetNode: HTMLDivElement) => void | Unmount a configure SSO component from the target element. If there is no component mounted at the target node, results in a noop. | | `__internal_attemptToEnableEnvironmentSetting` | (options: **internal_AttemptToEnableEnvironmentSettingParams) => **internal_AttemptToEnableEnvironmentSettingResult | Attempts to enable a environment setting from a development instance, prompting if disabled. | | `__internal_closeCheckout` | () => void | Closes the Clerk Checkout drawer. | | `__internal_closeEnableOrganizationsPrompt` | () => void | Closes the Clerk Enable Organizations modal. | diff --git a/clerk-typedoc/shared/errors.mdx b/clerk-typedoc/shared/errors.mdx index ef5e63a79a..113cac846f 100644 --- a/clerk-typedoc/shared/errors.mdx +++ b/clerk-typedoc/shared/errors.mdx @@ -2,8 +2,8 @@ Represents the errors that occurred during the last fetch of the parent resource ## Properties -| Property | Type | Description | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `fields` | `T` | Represents the collection of possible errors on known fields. | -| `global` | null \| ClerkError & \{ isClerkAPIResponseError: \{ (error: unknown): error is ClerkAPIResponseError; (this: unknown): this is ClerkAPIResponseError; \}; isClerkRuntimeError: \{ (error: unknown): error is ClerkRuntimeError; (this: unknown): this is ClerkRuntimeError; \}; \}[] | Parsed errors that are not related to any specific field. Does not include any errors that could be parsed as a field error | -| `raw` | null \| unknown[] | The raw, unparsed errors from the Clerk API. | +| Property | Type | Description | +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `fields` | `T` | Represents the collection of possible errors on known fields. | +| `global` | null \| ClerkError & \{ isClerkAPIResponseError: \{ (error: unknown): error is [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error); (this: unknown): this is [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error); \}; isClerkRuntimeError: \{ (error: unknown): error is ClerkRuntimeError; (this: unknown): this is ClerkRuntimeError; \}; \}[] | Parsed errors that are not related to any specific field. Does not include any errors that could be parsed as a field error | +| `raw` | null \| unknown[] | The raw, unparsed errors from the Clerk API. | diff --git a/clerk-typedoc/shared/experimental_configure-sso-props.mdx b/clerk-typedoc/shared/experimental_configure-sso-props.mdx new file mode 100644 index 0000000000..593878bea8 --- /dev/null +++ b/clerk-typedoc/shared/experimental_configure-sso-props.mdx @@ -0,0 +1,7 @@ +> **\_\_experimental_ConfigureSSOProps** = \{ appearance?: [ClerkAppearanceTheme](clerk-appearance-theme.mdx); \} + +## Properties + +| Property | Type | Description | +| ------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `appearance?` | [`ClerkAppearanceTheme`](clerk-appearance-theme.mdx) | Customisation options to fully match the Clerk components to your own brand. These options serve as overrides and will be merged with the global `appearance` prop of ClerkProvider (if one is provided) | diff --git a/clerk-typedoc/shared/o-auth-application-namespace.mdx b/clerk-typedoc/shared/o-auth-application-namespace.mdx index cb2990febe..8a69516721 100644 --- a/clerk-typedoc/shared/o-auth-application-namespace.mdx +++ b/clerk-typedoc/shared/o-auth-application-namespace.mdx @@ -2,7 +2,7 @@ Namespace exposed on `Clerk` for OAuth application / consent helpers. ## Properties -| Property | Type | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `buildConsentActionUrl` | (params: \{ clientId: string; \}) => string | Returns the URL to use as the `action` attribute of the consent form. Includes `_clerk_session_id` and, in development, the dev browser JWT. Custom-flow developers building their own consent UI use this alongside the `useOAuthConsent` hook. | -| `getConsentInfo` | (params: GetOAuthConsentInfoParams) => Promise\<[OAuthConsentInfo](o-auth-consent-info.mdx)\> | Loads consent metadata for the given OAuth client for the signed-in user. | +| Property | Type | Description | +| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `buildConsentActionUrl` | (params: \{ clientId: string; \}) => string | Returns the URL to use as the `action` attribute of the consent form. Includes `_clerk_session_id` and, in development, the dev browser JWT. Custom-flow developers building their own consent UI use this alongside the `useOAuthConsent` hook. | +| `getConsentInfo` | (params: GetOAuthConsentInfoParams) => Promise\<[OAuthConsentInfo](/docs/reference/types/oauth-consent-info)\> | Loads consent metadata for the given OAuth client for the signed-in user. | diff --git a/clerk-typedoc/shared/o-auth-consent-info.mdx b/clerk-typedoc/shared/o-auth-consent-info.mdx index c30cf20821..fa417f41bd 100644 --- a/clerk-typedoc/shared/o-auth-consent-info.mdx +++ b/clerk-typedoc/shared/o-auth-consent-info.mdx @@ -1,2 +1,12 @@ -OAuth consent screen metadata from `GET /v1/me/oauth/consent/{oauthClientId}`. -Includes information needed to populate the consent dialog. +An interface representing OAuth consent information, including application details and requested scopes. + +## Properties + +| Property | Type | Description | +| -------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `clientId` | `string` | The OAuth `client_id` identifying the application. | +| `oauthApplicationLogoUrl` | `string` | The URL of the OAuth application's logo image. | +| `oauthApplicationName` | `string` | The display name of the OAuth application requesting access. | +| `oauthApplicationUrl` | `string` | The homepage URL of the OAuth application. | +| `scopes` | [OAuthConsentScope](/docs/reference/types/oauth-consent-scope)[] | A list of scopes the application is requesting, with descriptions and consent requirements. | +| `state` | `string` | The `state` parameter from the original authorize request. | diff --git a/clerk-typedoc/shared/o-auth-consent-scope.mdx b/clerk-typedoc/shared/o-auth-consent-scope.mdx index bc0abf0aff..f1f8f01f9d 100644 --- a/clerk-typedoc/shared/o-auth-consent-scope.mdx +++ b/clerk-typedoc/shared/o-auth-consent-scope.mdx @@ -1 +1,9 @@ A single OAuth scope with its description and whether it requires consent. + +## Properties + +| Property | Type | Description | +| ---------------------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `description` | null \| string | The description of the scope, which can be shown to users on the consent screen. This may be `null` if no description is available. | +| `requiresConsent` | `boolean` | Whether or not this scope requires explicit user consent. If `false`, the scope is considered "safe" and can be granted without showing the consent screen to the user. | +| `scope` | `string` | The name of the scope, as defined by the OAuth application. | diff --git a/clerk-typedoc/shared/paginated-resources.mdx b/clerk-typedoc/shared/paginated-resources.mdx index ffd4b02046..07dd7554f7 100644 --- a/clerk-typedoc/shared/paginated-resources.mdx +++ b/clerk-typedoc/shared/paginated-resources.mdx @@ -2,7 +2,7 @@ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `number` | The total count of data that exist remotely. | | `data` | T[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Clerk's API response error object. | | `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | | `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | | `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | diff --git a/clerk-typedoc/shared/use-api-keys-return.mdx b/clerk-typedoc/shared/use-api-keys-return.mdx index f351fa773d..d0aa10f5bb 100644 --- a/clerk-typedoc/shared/use-api-keys-return.mdx +++ b/clerk-typedoc/shared/use-api-keys-return.mdx @@ -4,7 +4,7 @@ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `number` | The total count of data that exist remotely. | | `data` | APIKeyResource[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Clerk's API response error object. | | `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | | `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | | `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | diff --git a/clerk-typedoc/shared/use-o-auth-consent-params.mdx b/clerk-typedoc/shared/use-o-auth-consent-params.mdx new file mode 100644 index 0000000000..8744817533 --- /dev/null +++ b/clerk-typedoc/shared/use-o-auth-consent-params.mdx @@ -0,0 +1,6 @@ +| Property | Type | Description | +| ------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------- | +| `enabled?` | `boolean` | If `true`, a request will be triggered when the hook is mounted and the user is signed in. Defaults to `true`. | +| `keepPreviousData?` | `boolean` | If `true`, the previous data will be kept in the cache until new data is fetched. Defaults to `true`. | +| `oauthClientId` | `string` | The OAuth `client_id` from the authorize request. The hook is disabled when this value is empty or omitted. | +| `scope?` | `string` | A space-delimited scope string from the authorize request. | diff --git a/clerk-typedoc/shared/use-o-auth-consent-return.mdx b/clerk-typedoc/shared/use-o-auth-consent-return.mdx new file mode 100644 index 0000000000..0440211bd5 --- /dev/null +++ b/clerk-typedoc/shared/use-o-auth-consent-return.mdx @@ -0,0 +1,6 @@ +| Property | Type | Description | +| ------------------------------------ | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| `data` | undefined \| [OAuthConsentInfo](/docs/reference/types/oauth-consent-info) | The OAuth consent screen metadata returned by Clerk, or `undefined` before the first successful fetch. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Any error that occurred during the data fetch, or `null` if no error occurred. | +| `isFetching` | `boolean` | Whether any request is still in flight, including background updates. | +| `isLoading` | `boolean` | Whether the initial consent metadata fetch is still in progress. | diff --git a/clerk-typedoc/shared/use-o-auth-consent.mdx b/clerk-typedoc/shared/use-o-auth-consent.mdx new file mode 100644 index 0000000000..389219a567 --- /dev/null +++ b/clerk-typedoc/shared/use-o-auth-consent.mdx @@ -0,0 +1,24 @@ +The `useOAuthConsent()` hook loads OAuth application consent metadata for the **signed-in** user +(`GET /me/oauth/consent/{oauthClientId}`). Ensure the user is authenticated before relying on this hook +(for example, redirect to sign-in on your custom consent route). + +## Parameters + +| Parameter | Type | +| --------- | -------------------------------------------------------- | +| `params` | [`UseOAuthConsentParams`](use-o-auth-consent-params.mdx) | + +## Returns + +[`UseOAuthConsentReturn`](use-o-auth-consent-return.mdx) + +## Example + +```tsx +import { useOAuthConsent } from "@clerk/react/internal"; + +const { data, isLoading, error } = useOAuthConsent({ + oauthClientId: clientIdFromProps, + scope: scopeFromProps, +}); +``` diff --git a/clerk-typedoc/shared/use-organization-creation-defaults-return.mdx b/clerk-typedoc/shared/use-organization-creation-defaults-return.mdx index 43930ae7bb..308cfbe102 100644 --- a/clerk-typedoc/shared/use-organization-creation-defaults-return.mdx +++ b/clerk-typedoc/shared/use-organization-creation-defaults-return.mdx @@ -1,6 +1,6 @@ | Property | Type | Description | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `data` | undefined \| null \| [OrganizationCreationDefaultsResource](#organization-creation-defaults-resource) | The organization creation defaults resource, `undefined` before the first fetch, or `null` if not available. | -| `error` | null \| ClerkAPIResponseError | Any error that occurred during the data fetch, or `null` if no error occurred. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Any error that occurred during the data fetch, or `null` if no error occurred. | | `isFetching` | `boolean` | A boolean that indicates whether any request is still in flight, including background updates. | | `isLoading` | `boolean` | A boolean that indicates whether the initial data is still being fetched. | diff --git a/clerk-typedoc/shared/use-payment-attempts-return.mdx b/clerk-typedoc/shared/use-payment-attempts-return.mdx index 140c72be9e..979d844d24 100644 --- a/clerk-typedoc/shared/use-payment-attempts-return.mdx +++ b/clerk-typedoc/shared/use-payment-attempts-return.mdx @@ -2,7 +2,7 @@ | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `number` | The total count of data that exist remotely. | | `data` | [BillingPaymentResource](/docs/reference/types/billing-payment-resource)[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Clerk's API response error object. | | `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | | `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | | `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | diff --git a/clerk-typedoc/shared/use-payment-methods-return.mdx b/clerk-typedoc/shared/use-payment-methods-return.mdx index f4468d8761..c15395ded0 100644 --- a/clerk-typedoc/shared/use-payment-methods-return.mdx +++ b/clerk-typedoc/shared/use-payment-methods-return.mdx @@ -2,7 +2,7 @@ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `number` | The total count of data that exist remotely. | | `data` | [BillingPaymentMethodResource](/docs/reference/types/billing-payment-method-resource)[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Clerk's API response error object. | | `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | | `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | | `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | diff --git a/clerk-typedoc/shared/use-plans-return.mdx b/clerk-typedoc/shared/use-plans-return.mdx index 2ac9a74908..9a31563edb 100644 --- a/clerk-typedoc/shared/use-plans-return.mdx +++ b/clerk-typedoc/shared/use-plans-return.mdx @@ -2,7 +2,7 @@ | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `number` | The total count of data that exist remotely. | | `data` | [BillingPlanResource](/docs/reference/types/billing-plan-resource)[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Clerk's API response error object. | | `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | | `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | | `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | diff --git a/clerk-typedoc/shared/use-statements-return.mdx b/clerk-typedoc/shared/use-statements-return.mdx index 1ce88da903..f7960256ae 100644 --- a/clerk-typedoc/shared/use-statements-return.mdx +++ b/clerk-typedoc/shared/use-statements-return.mdx @@ -2,7 +2,7 @@ | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `number` | The total count of data that exist remotely. | | `data` | [BillingStatementResource](/docs/reference/types/billing-statement-resource)[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `error` | null \| [ClerkAPIResponseError](/docs/reference/types/clerk-api-response-error) | Clerk's API response error object. | | `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | | `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | | `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | diff --git a/docs/manifest.json b/docs/manifest.json index c58141fb93..a190172709 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -3431,6 +3431,18 @@ "title": "Backend `EnterpriseAccountConnection` object", "href": "/docs/reference/backend/types/backend-enterprise-account-connection" }, + { + "title": "Backend `EnterpriseConnection` object", + "href": "/docs/reference/backend/types/backend-enterprise-connection" + }, + { + "title": "Backend `EnterpriseConnectionOauthConfig` object", + "href": "/docs/reference/backend/types/backend-enterprise-connection-oauth-config" + }, + { + "title": "Backend `EnterpriseConnectionSamlConnection` object", + "href": "/docs/reference/backend/types/backend-enterprise-connection-saml-connection" + }, { "title": "Backend `ExternalAccount` object", "href": "/docs/reference/backend/types/backend-external-account" diff --git a/docs/reference/backend/types/backend-enterprise-connection-oauth-config.mdx b/docs/reference/backend/types/backend-enterprise-connection-oauth-config.mdx new file mode 100644 index 0000000000..2a35a0ad3a --- /dev/null +++ b/docs/reference/backend/types/backend-enterprise-connection-oauth-config.mdx @@ -0,0 +1,6 @@ +--- +title: The Backend `EnterpriseConnectionOauthConfig` object +description: The Backend EnterpriseConnectionOauthConfig object represents the OAuth configuration data included in a Backend API EnterpriseConnection response. +--- + + diff --git a/docs/reference/backend/types/backend-enterprise-connection-saml-connection.mdx b/docs/reference/backend/types/backend-enterprise-connection-saml-connection.mdx new file mode 100644 index 0000000000..b7f5ff31ee --- /dev/null +++ b/docs/reference/backend/types/backend-enterprise-connection-saml-connection.mdx @@ -0,0 +1,6 @@ +--- +title: The Backend `EnterpriseConnectionSamlConnection` object +description: The Backend EnterpriseConnectionSamlConnection object holds information about a SAML enterprise connection for an instance or organization. +--- + + diff --git a/docs/reference/backend/types/backend-enterprise-connection.mdx b/docs/reference/backend/types/backend-enterprise-connection.mdx new file mode 100644 index 0000000000..74c436bd8e --- /dev/null +++ b/docs/reference/backend/types/backend-enterprise-connection.mdx @@ -0,0 +1,6 @@ +--- +title: The Backend `EnterpriseConnection` object +description: The Backend EnterpriseConnection object holds information about an enterprise connection (SAML or OAuth) for an instance or organization. +--- + + diff --git a/scripts/build-docs.ts b/scripts/build-docs.ts index 7bdafc126c..d695ded7b0 100644 --- a/scripts/build-docs.ts +++ b/scripts/build-docs.ts @@ -197,7 +197,11 @@ async function main() { 'guides/development/webhooks/inngest.mdx': ['doc-not-in-manifest'], 'guides/development/webhooks/loops.mdx': ['doc-not-in-manifest'], }, - typedoc: {}, + typedoc: { + 'shared/o-auth-application-namespace.mdx': ['link-doc-not-found'], + 'shared/o-auth-consent-info.mdx': ['link-doc-not-found'], + 'shared/use-o-auth-consent-return.mdx': ['link-doc-not-found'], + }, partials: {}, tooltips: {}, },