Skip to content

[ci] Update Typedoc (7a5892f) - Core 3 #3348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SarahSoutoul merged 4 commits into from
May 8, 2026
Merged

[ci] Update Typedoc (7a5892f) - Core 3 #3348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7fb763a
Add typedoc outputs
SarahSoutoul May 5, 2026
978ea54
docs: update TypeDoc documentation from clerk/javascript@7a5892f
github-actions[bot] May 6, 2026
b8952db
Merge branch 'ss/typedoc-enterprise-changes' into typedoc-7a5892f
SarahSoutoul May 6, 2026
6afa439
Fix linting
SarahSoutoul May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clerk-typedoc/backend/enterprise-account-connection.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion clerk-typedoc/backend/enterprise-connection-oauth-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
19 changes: 19 additions & 0 deletions clerk-typedoc/backend/enterprise-connection-saml-connection.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
The Backend `EnterpriseConnectionSamlConnection` object holds information about a SAML enterprise connection for an instance or organization.

## Properties

| Property | Type | Description |
| ---------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------- |
| <a id="acsurl"></a> `acsUrl` | `string` | The Assertion Consumer Service (ACS) URL of the connection. |
| <a id="allowidpinitiated"></a> `allowIdpInitiated` | `boolean` | Indicates whether Identity Provider (IdP) initiated flows are allowed. |
| <a id="allowsubdomains"></a> `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection. |
| <a id="id"></a> `id` | `string` | The unique identifier for the SAML connection. |
| <a id="idpcertificate"></a> `idpCertificate` | `string` | The X.509 certificate as provided by the Identity Provider (IdP). |
| <a id="idpentityid"></a> `idpEntityId` | `string` | The Entity ID as provided by the Identity Provider (IdP). |
| <a id="idpmetadata"></a> `idpMetadata` | `string` | The XML content of the Identity Provider (IdP) metadata file. |
| <a id="idpmetadataurl"></a> `idpMetadataUrl` | `string` | The URL which serves the Identity Provider (IdP) metadata. |
| <a id="idpssourl"></a> `idpSsoUrl` | `string` | The Single-Sign On URL as provided by the Identity Provider (IdP). |
| <a id="name"></a> `name` | `string` | The name to use as a label for the connection. |
| <a id="spentityid"></a> `spEntityId` | `string` | The Entity ID as provided by the Service Provider (Clerk). |
| <a id="spmetadataurl"></a> `spMetadataUrl` | `string` | The metadata URL as provided by the Service Provider (Clerk). |
| <a id="syncuserattributes"></a> `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk. |
28 changes: 14 additions & 14 deletions clerk-typedoc/backend/enterprise-connection.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ The Backend `EnterpriseConnection` object holds information about an enterprise

## Properties

| Property | Type | Description |
| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| <a id="active"></a> `active` | `boolean` | Indicates whether the connection is active or not. |
| <a id="allowsubdomains"></a> `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection or not. |
| <a id="createdat"></a> `createdAt` | `number` | The date when the connection was first created. |
| <a id="disableadditionalidentifications"></a> `disableAdditionalIdentifications` | `boolean` | Indicates whether additional identifications are disabled for this connection. |
| <a id="domains"></a> `domains` | <code>string[]</code> | The domain of the enterprise. Sign-in flows using an email with this domain may use the connection. |
| <a id="id"></a> `id` | `string` | The unique identifier for the connection. |
| <a id="name"></a> `name` | `string` | The name to use as a label for the connection. |
| <a id="oauthconfig"></a> `oauthConfig` | <code>null \| [EnterpriseConnectionOauthConfig](enterprise-connection-oauth-config.mdx)</code> | OAuth (OIDC) configuration when the enterprise connection uses OAuth. |
| <a id="organizationid"></a> `organizationId` | <code>null \| string</code> | The Organization ID if the connection is scoped to an organization. |
| <a id="samlconnection"></a> `samlConnection` | <code>null \| EnterpriseConnectionSamlConnection</code> | SAML connection details when the enterprise connection uses SAML. |
| <a id="syncuserattributes"></a> `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk or not. |
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the connection was last updated. |
| Property | Type | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| <a id="active"></a> `active` | `boolean` | Indicates whether the connection is active or not. |
| <a id="allowsubdomains"></a> `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection or not. |
| <a id="createdat"></a> `createdAt` | `number` | The date when the connection was first created. |
| <a id="disableadditionalidentifications"></a> `disableAdditionalIdentifications` | `boolean` | Indicates whether additional identifications are disabled for this connection. |
| <a id="domains"></a> `domains` | <code>string[]</code> | The domain of the enterprise. Sign-in flows using an email with this domain may use the connection. |
| <a id="id"></a> `id` | `string` | The unique identifier for the connection. |
| <a id="name"></a> `name` | `string` | The name to use as a label for the connection. |
| <a id="oauthconfig"></a> `oauthConfig` | <code>null \| [EnterpriseConnectionOauthConfig](/docs/reference/backend/types/backend-enterprise-connection-oauth-config)</code> | OAuth (OIDC) configuration when the enterprise connection uses OAuth. |
| <a id="organizationid"></a> `organizationId` | <code>null \| string</code> | The Organization ID if the connection is scoped to an organization. |
| <a id="samlconnection"></a> `samlConnection` | <code>null \| [EnterpriseConnectionSamlConnection](/docs/reference/backend/types/backend-enterprise-connection-saml-connection)</code> | SAML connection details when the enterprise connection uses SAML. |
| <a id="syncuserattributes"></a> `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk or not. |
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the connection was last updated. |
5 changes: 5 additions & 0 deletions clerk-typedoc/react/configure-sso-params.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Parameters

| Parameter | Type |
| --------- | --------------------------- |
| `props` | `Without`\<`P`, `"clerk"`\> |
7 changes: 7 additions & 0 deletions clerk-typedoc/react/configure-sso-return.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Returns

<code>null \| Element</code>

| Name | Type |
| -------------------------------------- | -------- |
| <a id="displayname"></a> `displayName` | `string` |
13 changes: 13 additions & 0 deletions clerk-typedoc/react/configure-sso.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Parameters

| Parameter | Type |
| --------- | --------------------------- |
| `props` | `Without`\<`P`, `"clerk"`\> |

## Returns

<code>null \| Element</code>

| Name | Type |
| -------------------------------------- | -------- |
| <a id="displayname"></a> `displayName` | `string` |
5 changes: 5 additions & 0 deletions clerk-typedoc/react/use-o-auth-consent-params.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Parameters

| Parameter | Type |
| --------- | ----------------------- |
| `params` | `UseOAuthConsentParams` |
3 changes: 3 additions & 0 deletions clerk-typedoc/react/use-o-auth-consent-return.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Returns

`UseOAuthConsentReturn`
24 changes: 24 additions & 0 deletions clerk-typedoc/react/use-o-auth-consent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
});
```
2 changes: 2 additions & 0 deletions clerk-typedoc/shared/clerk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Main Clerk SDK object.
| Property | Type | Description |
| -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="__experimental_checkout"></a> `__experimental_checkout` | `__experimental_CheckoutFunction` | Checkout API |
| <a id="__experimental_mountconfiguresso"></a> `__experimental_mountConfigureSSO` | <code>(targetNode: HTMLDivElement, props?: [\_\_experimental_ConfigureSSOProps](experimental_configure-sso-props.mdx)) => void</code> | Mount a configure SSO component at the target element. |
| <a id="__experimental_prefetchorganizationswitcher"></a> `__experimental_prefetchOrganizationSwitcher` | <code>() => void</code> | Prefetches the data displayed by an Organization switcher. It can be used when `mountOrganizationSwitcher({ asStandalone: true})`, to avoid unwanted loading states. |
| <a id="__experimental_unmountconfiguresso"></a> `__experimental_unmountConfigureSSO` | <code>(targetNode: HTMLDivElement) => void</code> | Unmount a configure SSO component from the target element. If there is no component mounted at the target node, results in a noop. |
| <a id="__internal_attempttoenableenvironmentsetting"></a> `__internal_attemptToEnableEnvironmentSetting` | <code>(options: **internal_AttemptToEnableEnvironmentSettingParams) => **internal_AttemptToEnableEnvironmentSettingResult</code> | Attempts to enable a environment setting from a development instance, prompting if disabled. |
| <a id="__internal_closecheckout"></a> `__internal_closeCheckout` | <code>() => void</code> | Closes the Clerk Checkout drawer. |
| <a id="__internal_closeenableorganizationsprompt"></a> `__internal_closeEnableOrganizationsPrompt` | <code>() => void</code> | Closes the Clerk Enable Organizations modal. |
Expand Down
Loading
Loading