List enterprise connections | Clerk API (unofficial showcase)

4 parameters

limitintegeroptional

Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.

Default:10

offsetintegeroptional

Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.

Default:0

organization_idstringoptional

Filter enterprise connections by organization ID

activebooleanoptional

Filter by active status. If true, only active connections are returned. If false, only inactive connections are returned. If omitted, all connections are returned.

4 status codes

200A list of enterprise connections

dataarray<object>required

total_countintegerrequired

Total number of enterprise connections

402Payment required

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

403Authorization invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

422Invalid request parameters

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

Error handling

A 402 is returned: Payment required. A 403 is returned: Authorization invalid. A 422 is returned: Invalid request parameters.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.enterpriseConnections.list({
  limit: 20,
  offset: 0,
  organizationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  active: "example",
});

{
  "data": [
    {
      "object": "enterprise_connection",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "provider": "Example Academy Trust",
      "logo_public_url": "https://example.com",
      "active": true,
      "domains": [
        "example_value"
      ],
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "sync_user_attributes": true,
      "disable_additional_identifications": true,
      "allow_organization_account_linking": true,
      "custom_attributes": [
        {
          "name": "Example Name",
          "key": "example_key_abc123",
          "sso_path": "example_value",
          "scim_path": "example_value",
          "directory_path": "example_value",
          "multi_valued": true
        }
      ],
      "saml_connection": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "idp_entity_id": "550e8400-e29b-41d4-a716-446655440000",
        "idp_sso_url": "https://example.com",
        "idp_certificate": "example_value",
        "idp_certificate_issued_at": 1,
        "idp_certificate_expires_at": 1,
        "idp_certificates": [
          {
            "certificate": "example_value",
            "issued_at": 1,
            "expires_at": 1
          }
        ],
        "idp_metadata_url": "https://example.com",
        "acs_url": "https://example.com",
        "sp_entity_id": "550e8400-e29b-41d4-a716-446655440000",
        "sp_metadata_url": "https://example.com",
        "active": true,
        "allow_idp_initiated": true,
        "allow_subdomains": true,
        "force_authn": true,
        "login_hint": {
          "mode": "email_address",
          "source": "example_value"
        }
      },
      "oauth_config": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "provider_key": "example_key_abc123",
        "client_id": "550e8400-e29b-41d4-a716-446655440000",
        "discovery_url": "https://example.com",
        "auth_url": "https://example.com",
        "token_url": "https://example.com",
        "user_info_url": "https://example.com",
        "requires_pkce": true,
        "logo_public_url": "https://example.com",
        "created_at": 1,
        "updated_at": "2026-01-15T09:00:00Z"
      },
      "created_at": 1,
      "updated_at": "2026-01-15T09:00:00Z"
    }
  ],
  "total_count": 42
}

Request

Response

Errors