Skip to content

Commit 3f82ebd

Browse files
github-actions[bot]SarahSoutoul
github-actions[bot]
and
SarahSoutoul
authored
[ci] Update Typedoc (7a5892f) - Core 3 (#3348)
Co-authored-by: Sarah Soutoul <sarah@clerk.dev> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 7702d71 commit 3f82ebd

31 files changed

Lines changed: 208 additions & 35 deletions

‎clerk-typedoc/backend/enterprise-account-connection.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Represents an enterprise SSO connection associated with an enterprise account.
1+
The Backend `EnterpriseAccountConnection` object represents an enterprise SSO connection associated with an enterprise account.
22

33
## Properties
44

‎clerk-typedoc/backend/enterprise-connection-oauth-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OAuth configuration included on a Backend API [EnterpriseConnection](enterprise-connection.mdx) response.
1+
OAuth configuration included on a Backend API [EnterpriseConnection](/docs/reference/backend/types/backend-enterprise-connection) response.
22

33
## Properties
44

‎clerk-typedoc/backend/enterprise-connection-saml-connection.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The Backend `EnterpriseConnectionSamlConnection` object holds information about a SAML enterprise connection for an instance or organization.
2+
3+
## Properties
4+
5+
| Property | Type | Description |
6+
| ---------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------- |
7+
| <a id="acsurl"></a> `acsUrl` | `string` | The Assertion Consumer Service (ACS) URL of the connection. |
8+
| <a id="allowidpinitiated"></a> `allowIdpInitiated` | `boolean` | Indicates whether Identity Provider (IdP) initiated flows are allowed. |
9+
| <a id="allowsubdomains"></a> `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection. |
10+
| <a id="id"></a> `id` | `string` | The unique identifier for the SAML connection. |
11+
| <a id="idpcertificate"></a> `idpCertificate` | `string` | The X.509 certificate as provided by the Identity Provider (IdP). |
12+
| <a id="idpentityid"></a> `idpEntityId` | `string` | The Entity ID as provided by the Identity Provider (IdP). |
13+
| <a id="idpmetadata"></a> `idpMetadata` | `string` | The XML content of the Identity Provider (IdP) metadata file. |
14+
| <a id="idpmetadataurl"></a> `idpMetadataUrl` | `string` | The URL which serves the Identity Provider (IdP) metadata. |
15+
| <a id="idpssourl"></a> `idpSsoUrl` | `string` | The Single-Sign On URL as provided by the Identity Provider (IdP). |
16+
| <a id="name"></a> `name` | `string` | The name to use as a label for the connection. |
17+
| <a id="spentityid"></a> `spEntityId` | `string` | The Entity ID as provided by the Service Provider (Clerk). |
18+
| <a id="spmetadataurl"></a> `spMetadataUrl` | `string` | The metadata URL as provided by the Service Provider (Clerk). |
19+
| <a id="syncuserattributes"></a> `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk. |

‎clerk-typedoc/backend/enterprise-connection.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ The Backend `EnterpriseConnection` object holds information about an enterprise
22

33
## Properties
44

5-
| Property | Type | Description |
6-
| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
7-
| <a id="active"></a> `active` | `boolean` | Indicates whether the connection is active or not. |
8-
| <a id="allowsubdomains"></a> `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection or not. |
9-
| <a id="createdat"></a> `createdAt` | `number` | The date when the connection was first created. |
10-
| <a id="disableadditionalidentifications"></a> `disableAdditionalIdentifications` | `boolean` | Indicates whether additional identifications are disabled for this connection. |
11-
| <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. |
12-
| <a id="id"></a> `id` | `string` | The unique identifier for the connection. |
13-
| <a id="name"></a> `name` | `string` | The name to use as a label for the connection. |
14-
| <a id="oauthconfig"></a> `oauthConfig` | <code>null \| [EnterpriseConnectionOauthConfig](enterprise-connection-oauth-config.mdx)</code> | OAuth (OIDC) configuration when the enterprise connection uses OAuth. |
15-
| <a id="organizationid"></a> `organizationId` | <code>null \| string</code> | The Organization ID if the connection is scoped to an organization. |
16-
| <a id="samlconnection"></a> `samlConnection` | <code>null \| EnterpriseConnectionSamlConnection</code> | SAML connection details when the enterprise connection uses SAML. |
17-
| <a id="syncuserattributes"></a> `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk or not. |
18-
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the connection was last updated. |
5+
| Property | Type | Description |
6+
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
7+
| <a id="active"></a> `active` | `boolean` | Indicates whether the connection is active or not. |
8+
| <a id="allowsubdomains"></a> `allowSubdomains` | `boolean` | Indicates whether users with an email address subdomain are allowed to use this connection or not. |
9+
| <a id="createdat"></a> `createdAt` | `number` | The date when the connection was first created. |
10+
| <a id="disableadditionalidentifications"></a> `disableAdditionalIdentifications` | `boolean` | Indicates whether additional identifications are disabled for this connection. |
11+
| <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. |
12+
| <a id="id"></a> `id` | `string` | The unique identifier for the connection. |
13+
| <a id="name"></a> `name` | `string` | The name to use as a label for the connection. |
14+
| <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. |
15+
| <a id="organizationid"></a> `organizationId` | <code>null \| string</code> | The Organization ID if the connection is scoped to an organization. |
16+
| <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. |
17+
| <a id="syncuserattributes"></a> `syncUserAttributes` | `boolean` | Indicates whether the connection syncs user attributes between the IdP and Clerk or not. |
18+
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the connection was last updated. |

‎clerk-typedoc/react/configure-sso-params.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Parameters
2+
3+
| Parameter | Type |
4+
| --------- | --------------------------- |
5+
| `props` | `Without`\<`P`, `"clerk"`\> |

‎clerk-typedoc/react/configure-sso-return.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Returns
2+
3+
<code>null \| Element</code>
4+
5+
| Name | Type |
6+
| -------------------------------------- | -------- |
7+
| <a id="displayname"></a> `displayName` | `string` |

‎clerk-typedoc/react/configure-sso.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Parameters
2+
3+
| Parameter | Type |
4+
| --------- | --------------------------- |
5+
| `props` | `Without`\<`P`, `"clerk"`\> |
6+
7+
## Returns
8+
9+
<code>null \| Element</code>
10+
11+
| Name | Type |
12+
| -------------------------------------- | -------- |
13+
| <a id="displayname"></a> `displayName` | `string` |

‎clerk-typedoc/react/use-o-auth-consent-params.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Parameters
2+
3+
| Parameter | Type |
4+
| --------- | ----------------------- |
5+
| `params` | `UseOAuthConsentParams` |

‎clerk-typedoc/react/use-o-auth-consent-return.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Returns
2+
3+
`UseOAuthConsentReturn`

‎clerk-typedoc/react/use-o-auth-consent.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
The `useOAuthConsent()` hook loads OAuth application consent metadata for the **signed-in** user
2+
(`GET /me/oauth/consent/{oauthClientId}`). Ensure the user is authenticated before relying on this hook
3+
(for example, redirect to sign-in on your custom consent route).
4+
5+
## Parameters
6+
7+
| Parameter | Type |
8+
| --------- | ----------------------- |
9+
| `params` | `UseOAuthConsentParams` |
10+
11+
## Returns
12+
13+
`UseOAuthConsentReturn`
14+
15+
## Example
16+
17+
```tsx
18+
import { useOAuthConsent } from "@clerk/react/internal";
19+
20+
const { data, isLoading, error } = useOAuthConsent({
21+
oauthClientId: clientIdFromProps,
22+
scope: scopeFromProps,
23+
});
24+
```

0 commit comments

Comments
 (0)