Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1758,6 +1758,10 @@
"title": "`createEnterpriseConnection()`",
"href": "/docs/reference/backend/enterprise-connections/create-enterprise-connection"
},
{
"title": "`createEnterpriseConnectionTestRun()`",
"href": "/docs/reference/backend/enterprise-connections/create-enterprise-connection-test-run"
},
{
"title": "`deleteEnterpriseConnection()`",
"href": "/docs/reference/backend/enterprise-connections/delete-enterprise-connection"
Expand All @@ -1770,6 +1774,10 @@
"title": "`getEnterpriseConnectionList()`",
"href": "/docs/reference/backend/enterprise-connections/get-enterprise-connection-list"
},
{
"title": "`getEnterpriseConnectionTestRunList()`",
"href": "/docs/reference/backend/enterprise-connections/get-enterprise-connection-test-run-list"
},
{
"title": "`updateEnterpriseConnection()`",
"href": "/docs/reference/backend/enterprise-connections/update-enterprise-connection"
Expand Down Expand Up @@ -2239,6 +2247,26 @@
"title": "`EnterpriseConnectionSamlConnectionLoginHint` object",
"href": "/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint"
},
{
"title": "`EnterpriseConnectionTestRun` object",
"href": "/docs/reference/backend/types/backend-enterprise-connection-test-run"
},
{
"title": "`EnterpriseConnectionTestRunLog` object",
"href": "/docs/reference/backend/types/backend-enterprise-connection-test-run-log"
},
{
"title": "`EnterpriseConnectionTestRunOauthPayload` object",
"href": "/docs/reference/backend/types/backend-enterprise-connection-test-run-oauth-payload"
},
{
"title": "`EnterpriseConnectionTestRunParsedUserInfo` object",
"href": "/docs/reference/backend/types/backend-enterprise-connection-test-run-parsed-user-info"
},
{
"title": "`EnterpriseConnectionTestRunSamlPayload` object",
"href": "/docs/reference/backend/types/backend-enterprise-connection-test-run-saml-payload"
},
{
"title": "`ExternalAccount` object",
"href": "/docs/reference/backend/types/backend-external-account"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: '`createEnterpriseConnectionTestRun()`'
description: Use the createEnterpriseConnectionTestRun() method to start a test sign-in against an enterprise connection's identity provider.
---

<Typedoc src="backend/enterprise-connection-api/methods/create-enterprise-connection-test-run" />

## Usage

<Include src="_partials/backend/usage" />

```tsx
const { url } = await clerkClient.enterpriseConnections.createEnterpriseConnectionTestRun('ec_123')
```

## Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint `POST/enterprise_connections/{enterprise_connection_id}/test_runs`. See the [BAPI reference](/docs/reference/backend-api/tag/enterprise-connections/POST/enterprise_connections/%7Benterprise_connection_id%7D/test_runs){{ target: '_blank' }} for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: '`getEnterpriseConnectionTestRunList()`'
description: Use the getEnterpriseConnectionTestRunList() method to get the test runs for an enterprise connection.
---

<Typedoc src="backend/enterprise-connection-api/methods/get-enterprise-connection-test-run-list" />

## Usage

<Include src="_partials/backend/usage" />

```tsx
const response =
await clerkClient.enterpriseConnections.getEnterpriseConnectionTestRunList('ec_123')
```

### Filter by status

```tsx
const response = await clerkClient.enterpriseConnections.getEnterpriseConnectionTestRunList(
'ec_123',
{
status: ['failed'],
},
)
```

## Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint `GET/enterprise_connections/{enterprise_connection_id}/test_runs`. See the [BAPI reference](/docs/reference/backend-api/tag/enterprise-connections/GET/enterprise_connections/%7Benterprise_connection_id%7D/test_runs){{ target: '_blank' }} for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: The Backend `EnterpriseConnectionTestRunLog` object
description: The Backend EnterpriseConnectionTestRunLog object represents a log entry captured during an EnterpriseConnectionTestRun.
---

<Typedoc src="backend/enterprise-connection-test-run-log" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: The Backend `EnterpriseConnectionTestRunOauthPayload` object
description: The Backend EnterpriseConnectionTestRunOauthPayload object holds the raw OAuth (OIDC) payloads exchanged during an EnterpriseConnectionTestRun.
---

<Typedoc src="backend/enterprise-connection-test-run-oauth-payload" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: The Backend `EnterpriseConnectionTestRunParsedUserInfo` object
description: The Backend EnterpriseConnectionTestRunParsedUserInfo object holds the user information parsed from the identity provider during an EnterpriseConnectionTestRun.
---

<Typedoc src="backend/enterprise-connection-test-run-parsed-user-info" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: The Backend `EnterpriseConnectionTestRunSamlPayload` object
description: The Backend EnterpriseConnectionTestRunSamlPayload object holds the raw SAML payloads exchanged during an EnterpriseConnectionTestRun.
---

<Typedoc src="backend/enterprise-connection-test-run-saml-payload" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: The Backend `EnterpriseConnectionTestRun` object
description: The Backend EnterpriseConnectionTestRun object represents a test sign-in against an enterprise connection's identity provider.
---

<Typedoc src="backend/enterprise-connection-test-run" />
Loading