---
title: "List SSO Configs for a Realm."
method: GET
path: "/v1/tenants/{tenant_id}/realms/{realm_id}/sso-configs"
tags: ["SSO Configs"]
---

# List SSO Configs for a Realm.

`GET /v1/tenants/{tenant_id}/realms/{realm_id}/sso-configs`

## Request

- Base URL: `https://api-us.beyondidentity.com`
- URL: `https://api-us.beyondidentity.com/v1/tenants/{tenant_id}/realms/{realm_id}/sso-configs`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/docs/v1/tenants/:tenant_id/realms/:realm_id/sso-configs/get.ts> (a function with typed inputs; its response is checked against the schema)

To list SSO Configs for a Realm, send a GET request to
`/v1/tenants/$TENANT_ID/realms/$REALM_ID/sso-configs`.

The response will contain at most 200 items and may contain a page token to
query the remaining items. If page size is not specified, the response will
contain 20 items. There is no defined ordering of the list of identities in
the response. Note that the maximum and default page sizes are subject to
change.

When paginating, the page size is maintained by the page token but may be
overridden on subsequent requests.

Page tokens expire after one week. Requests which specify an expired page
token will result in undefined behavior.

## Path parameters

- `tenant_id` string, required
- `realm_id` string, required

## Query parameters

- `page_size` integer
- `page_token` string
- `type` SsoConfigType[]
- `is_migrated` boolean
- `order_by` string

## Headers

- `x-correlation_id` string, required

## Response `200`

Successful response.

- object: Represents a list of sso configs as a response body.
  - `sso_configs` object[], required: The sso configs which are part of the response.
    - `id` string, uuid, required: A unique identifier for an SSO config. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.
    - `display_name` string, required: A human-readable name for the SSO config. This name is used for display purposes.
    - `payload` union, required
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
        - `login_link` string, required
        - `icon` string
        - `is_tile_visible` boolean
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
        - `redirect_uris` string[], required
        - `discover_endpoint` DiscoverEndpoint, required (unresolved $ref)
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
        - `redirect_uris` string[], required
        - `login_link` string
        - `icon` string
        - `is_tile_visible` boolean
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
        - `icon` string: The URL or data URI of the icon representing the SSO configuration.
        - `is_tile_visible` boolean: Indicates if the SSO configuration tile is visible to the user.
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
        - `company_identifier` string, required
      - 9 (unresolved $ref)
      - object
        - `type` 'bookmark' | 'entra_id_external_auth_methods' | 'generic_oidc' | 'generic_oidc_idp' | 'generic_saml' | 'okta_idp' | 'okta_sso_bi_idp' | 'scim' | 'ws_fed' | 'nametag_oauth2', required: Describes the type of sso config.
        - `icon` string: The URL or data URI of the icon representing the SSO configuration.
        - `is_tile_visible` boolean: Indicates if the SSO configuration tile is visible to the user.
  - `total_size` integer, required: The total number of sso configs contained by the Realm.
  - `next_page_token` string, nullable: The value to be passed as the page_token parameter to retrieve the next page.

## Other responses

- `400`: The request is malformed.
- `401`: An invalid Authorization token has been supplied.
- `403`: The supplied authorization token doesn't allow the requested operation.
- `500`: Internal server error.

## Changes

- **2026-11-06** `42f3cac49392`: 1 breaking, 2 info
  - added `#/components/schemas/9, subschema #1, subschema #2, subschema #3, subschema #4, subschema #5, subschema #6, subschema #7, subschema #8, subschema #9, subschema #11` to the `sso_configs/items/payload` response property `oneOf` list for the response status `200`
  - added the enum value `nametag_oauth2` to the property `items/` of the `query` request parameter `type`
  - removed `#/components/schemas/8, subschema #1, subschema #2, subschema #3, subschema #4, subschema #5, subschema #6, subschema #7, subschema #8, subschema #10` from the `sso_configs/items/payload` response property `oneOf` list for the response status `200`

[Operation history](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/changes/v1/tenants/:tenant_id/realms/:realm_id/sso-configs/get.md)

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/revisions/42f3cac49392?raw)