Sign in

v1

latestOpenAPI 3.0.1CC BY-NC-SA 3.0 US2026-07-145251,1312.6 MB
Federated Authentication

Return All Identity Providers in One Federation

Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations.

get/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders

Path parameters

federationSettingsIdstring required
Example:55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

itemsPerPageinteger

Number of items that the response returns per page.

pageNuminteger

Number of the page that displays the current set of the total objects that the response returns.

protocolstring[]

The protocols of the target identity providers.

idpTypestring[]

The types of the target identity providers.

Response

OK