BEbeyondidentity
SSO Configs

List SSO Configs for a Realm.

Changed on

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.

get/v1/tenants/{tenant_id}/realms/{realm_id}/sso-configs

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Query parameters

page_sizeinteger

Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.

page_tokenstring

Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.

typeSsoConfigType[]

The type of sso config to filter by. You may query with multiple types for example "/sso-configs?type=generic_oidc&type=generic_oid_idp"

is_migratedboolean
order_bystring

Headers

x-correlation_idstring required

Correlation ID. If supplied with the request, the response must contain the same value. If not supplied with the request, it is generated by the server and returned in the response.

Response

Successful response.

total_sizeinteger required

The total number of sso configs contained by the Realm.

next_page_tokenstring nullable

The value to be passed as the page_token parameter to retrieve the next page.

Changes

  • 42f3cac49392Revision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #11 to the // response property oneOf list for the response status

    • info

      added the enum value nametag_oauth2 to the property items/ of the query request parameter type

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #10 from the // response property oneOf list for the response status