---
title: "List SSO connections"
method: GET
path: "/auth/sso/connections"
tags: ["SSO Connections"]
---

# List SSO connections

`GET /auth/sso/connections`

Retrieve SSO identity provider connections using optional filters and cursor-based pagination.

## Query parameters

- `filter[id]` string
- `filter[reference]` string
- `filter[type]` 'SAML'
- `filter[status]` 'enabled' | 'disabled'
- `filter[provider]` 'auth0' | 'jumpcloud' | 'microsoft' | 'okta'
- `page[cursor]` string — Cursor for paging results.
- `page[after]` string — Cursor for paging results.
- `page[before]` string — Cursor for paging results.
- `page[size]` integer

## Response `200`

Success.

- object
  - `results` object[], required
    - `id` string, uuid, required — Unique identifier of the SSO connection.
    - `reference` string, required — Identifier assigned by the downstream identity provider.
    - `type` 'SAML', required — Identity provider connection type.
    - `status` 'enabled' | 'disabled', required — Lifecycle status of the connection.
    - `metadata` object, required
      - `saml` object, required — SAML-specific metadata for the identity provider connection.
        - `samlMetadataURL` string, uri, required — HTTPS URL referencing the SAML metadata document.
    - `name` string, required — Internal name assigned to the connection.
    - `displayName` string, required — Display label returned to clients initiating SSO.
    - `provider` 'auth0' | 'jumpcloud' | 'microsoft' | 'okta', required — Allowed/Supported SSO providers.
    - `createdAt` string, date-time, required — ISO-8601 timestamp when the connection was created.
    - `updatedAt` string, date-time, required — ISO-8601 timestamp when the connection was last updated.
  - `links` object, required
    - `self` string, required
    - `prev` string
    - `next` string
    - `first` string
    - `last` string

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Insufficient Scope.
- `406` — Not Acceptable.
- `415` — Unsupported Media Type.
- `429` — Too Many Requests.
- `500` — Internal Server Error.

---

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