---
title: "Get a list of SAML Connections for an instance"
method: GET
path: "/saml_connections"
tags: ["SAML Connections"]
deprecated: true
---

# Get a list of SAML Connections for an instance

`GET /saml_connections`

> **Deprecated.**

Returns the list of SAML Connections for an instance.
Results can be paginated using the optional `limit` and `offset` query parameters.
The SAML Connections are ordered by descending creation date and the most recent will be returned first.
Deprecated: Use the Enterprise Connections API instead. This endpoint will be removed in future versions.

## Query parameters

- `limit` integer
- `offset` integer
- `query` string
- `order_by` string
- `organization_id` string[]

## Response `200`

A list of SAML Connections

- SAMLConnections
  - `data` SAMLConnection[], required
    - union
      - object
        - `object` 'saml_connection', required
        - `id` string, required
        - `name` string, required
        - `domain` string, required
        - `domains` string[]
        - `idp_entity_id` string, nullable, required
        - `idp_sso_url` string, nullable, required
        - `idp_certificate` string, nullable, required
        - `idp_certificate_issued_at` integer, nullable, required — Unix timestamp (milliseconds) of the start of the IdP certificate validity window (X.509 NotBefore). Null when no certificate is configured.
        - `idp_certificate_expires_at` integer, nullable, required — Unix timestamp (milliseconds) of the end of the IdP certificate validity window (X.509 NotAfter). Null when no certificate is configured.
        - `idp_metadata_url` string, nullable
        - `idp_metadata` string, nullable
        - `acs_url` string, required
        - `sp_entity_id` string, required
        - `sp_metadata_url` string, required
        - `organization_id` string, nullable
        - `attribute_mapping` SAMLConnectionAttributeMapping
          - `user_id` string, required
          - `email_address` string, required
          - `first_name` string, required
          - `last_name` string, required
        - `active` boolean, required
        - `provider` string, required
        - `user_count` integer, required
        - `sync_user_attributes` boolean, required
        - `allow_subdomains` boolean, required
        - `allow_idp_initiated` boolean, required
        - `disable_additional_identifications` boolean, required
        - `allow_organization_account_linking` boolean, required
        - `force_authn` boolean, required — Enable or deactivate ForceAuthn
        - `login_hint` SAMLConnectionLoginHint, required — Configuration for the login_hint sent to the IdP on SSO sign-in
          - `mode` 'email_address' | 'custom_attribute' | 'off', required — Controls the login_hint sent to the IdP on SSO sign-in
          - `source` string — The user public_metadata key whose value is sent as the login_hint when mode is custom_attribute
        - `enterprise_connection_id` string, nullable
        - `created_at` integer, required — Unix timestamp of creation.
        - `updated_at` integer, required — Unix timestamp of last update.
      - object
        - `object` 'saml_connection', required
        - `id` string, required
        - `name` string, required
        - `domain` string
        - `domains` string[], required
        - `idp_entity_id` string, nullable, required
        - `idp_sso_url` string, nullable, required
        - `idp_certificate` string, nullable, required
        - `idp_certificate_issued_at` integer, nullable, required — Unix timestamp (milliseconds) of the start of the IdP certificate validity window (X.509 NotBefore). Null when no certificate is configured.
        - `idp_certificate_expires_at` integer, nullable, required — Unix timestamp (milliseconds) of the end of the IdP certificate validity window (X.509 NotAfter). Null when no certificate is configured.
        - `idp_metadata_url` string, nullable
        - `idp_metadata` string, nullable
        - `acs_url` string, required
        - `sp_entity_id` string, required
        - `sp_metadata_url` string, required
        - `organization_id` string, nullable
        - `attribute_mapping` SAMLConnectionAttributeMapping
          - `user_id` string, required
          - `email_address` string, required
          - `first_name` string, required
          - `last_name` string, required
        - `active` boolean, required
        - `provider` string, required
        - `user_count` integer, required
        - `sync_user_attributes` boolean, required
        - `allow_subdomains` boolean, required
        - `allow_idp_initiated` boolean, required
        - `disable_additional_identifications` boolean, required
        - `allow_organization_account_linking` boolean, required
        - `force_authn` boolean, required — Enable or deactivate ForceAuthn
        - `login_hint` SAMLConnectionLoginHint, required — Configuration for the login_hint sent to the IdP on SSO sign-in
          - `mode` 'email_address' | 'custom_attribute' | 'off', required — Controls the login_hint sent to the IdP on SSO sign-in
          - `source` string — The user public_metadata key whose value is sent as the login_hint when mode is custom_attribute
        - `enterprise_connection_id` string, nullable
        - `created_at` integer, required — Unix timestamp of creation.
        - `updated_at` integer, required — Unix timestamp of last update.
  - `total_count` integer, required — Total number of SAML Connections

## Other responses

- `402` — Payment required
- `403` — Authorization invalid
- `422` — Invalid request parameters

---

[API](https://skmtc.net/clerk/apis/clerk-backend-api.md) · [All operations](https://skmtc.net/clerk/apis/clerk-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clerk/clerk-backend-api/versions/cf036e7951d3/schema)
