Return All Identity Providers in One Federation

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

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 API Key must have the Organization Owner role in one of the connected organizations.

Path parameters

federationSettingsId string Required

Unique 24-hexadecimal digit string that identifies your federation.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

Query parameters

envelope boolean

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.

Default value is false.
itemsPerPage integer

Number of items that the response returns per page.

Minimum value is 1, maximum value is 500. Default value is 100.
pageNum integer

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

Minimum value is 1. Default value is 1.
protocol array[string]

The protocols of the target identity providers.

Values are SAML or OIDC. Default value is SAML.
idpType array[string]

The types of the target identity providers.

Values are WORKFORCE or WORKLOAD. Default value is WORKFORCE.

Responses

200 application/vnd.atlas.2023-01-01+json

OK
Hide response attributes Show response attributes object
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- results array[object]
  
  List of returned documents that MongoDB Cloud providers when completing this request.
  
  One of:
  FederationSamlIdentityProvider object FederationOidcWorkforceIdentityProvider object FederationOidcWorkloadIdentityProvider object
  
  Hide attributes Show attributes
  
  associatedOrgs array[object]
  
  List that contains the connected organization configurations associated with the identity provider.
  
  Hide associatedOrgs attributes Show associatedOrgs attributes object
  
  dataAccessIdentityProviderIds array[string]
  
  The collection of unique ids representing the identity providers that can be used for data access in this organization.
  
  Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.
  
  domainAllowList array[string]
  
  Approved domains that restrict users who can join the organization based on their email address.
  
  domainRestrictionEnabled boolean Required
  
  Value that indicates whether domain restriction is enabled for this connected org.
  
  identityProviderId string
  
  Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^([a-f0-9]{20})$.
  
  orgId string Required
  
  Unique 24-hexadecimal digit string that identifies the connected organization configuration.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  postAuthRoleGrants array[string]
  
  Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
  
  roleMappings array[object]
  
  Role mappings that are configured in this organization.
  
  Mapping settings that link one IdP and MongoDB Cloud.
  
  Hide roleMappings attributes Show roleMappings attributes object
  
  externalGroupName string Required
  
  Unique human-readable label that identifies the identity provider group to which this role mapping applies.
  
  Minimum length is 1, maximum length is 200.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this role mapping.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleAssignments array[object]
  
  Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective orgId. Each element in the array can have a value for orgId or groupId, but not both.
  
  Hide roleAssignments attributes Show roleAssignments attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within roleAssignments can have a value for groupId or orgId, but not both.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  orgId string
  
  Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within roleAssignments can have a value for orgId or groupId, but not both.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  role string
  
  Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.
  
  Organization Roles
  
  ORG_OWNER
  
  ORG_MEMBER
  
  ORG_GROUP_CREATOR
  
  ORG_BILLING_ADMIN
  
  ORG_READ_ONLY
  
  Project Roles
  
  GROUP_CLUSTER_MANAGER
  
  GROUP_DATA_ACCESS_ADMIN
  
  GROUP_DATA_ACCESS_READ_ONLY
  
  GROUP_DATA_ACCESS_READ_WRITE
  
  GROUP_OWNER
  
  GROUP_READ_ONLY
  
  GROUP_SEARCH_INDEX_EDITOR
  
  GROUP_STREAM_PROCESSING_OWNER
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_READ_ONLY, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.
  
  userConflicts array[object]
  
  List that contains the users who have an email address that doesn't match any domain on the allowed list.
  
  MongoDB Cloud user linked to this federated authentication.
  
  Hide userConflicts attributes Show userConflicts attributes object
  
  emailAddress string(email) Required
  
  Email address of the MongoDB Cloud user linked to the federated organization.
  
  federationSettingsId string Required
  
  Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  firstName string Required
  
  First or given name that belongs to the MongoDB Cloud user.
  
  lastName string Required
  
  Last name, family name, or surname that belongs to the MongoDB Cloud user.
  
  userId string
  
  Unique 24-hexadecimal digit string that identifies this user.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  createdAt string(date-time)
  
  Date that the identity provider was created on.
  
  description string
  
  The description of the identity provider.
  
  displayName string
  
  Human-readable label that identifies the identity provider.
  
  id string Required
  
  Unique 24-hexadecimal digit string that identifies the identity provider.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  idpType string
  
  String enum that indicates the type of the identity provider. Default is WORKFORCE.
  
  Values are WORKFORCE or WORKLOAD.
  
  issuerUri string
  
  Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.
  
  oktaIdpId string Required
  
  Legacy 20-hexadecimal digit string that identifies the identity provider.
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^([a-f0-9]{20})$.
  
  protocol string
  
  String enum that indicates the protocol of the identity provider. Either SAML or OIDC.
  
  Values are SAML or OIDC.
  
  updatedAt string(date-time)
  
  Date that the identity provider was last updated on.
  
  acsUrl string
  
  URL that points to where to send the SAML response.
  
  associatedDomains array[string]
  
  List that contains the domains associated with the identity provider.
  
  audienceUri string
  
  Unique string that identifies the intended audience of the SAML assertion.
  
  pemFileInfo object
  
  PEM file information for the identity provider's current certificates.
  
  Hide pemFileInfo attributes Show pemFileInfo attributes object
  
  certificates array[object]
  
  List of certificates in the file.
  
  Hide certificates attributes Show certificates attributes object
  
  notAfter string(date-time)
  
  Latest date that the certificate is valid.
  
  notBefore string(date-time)
  
  Earliest date that the certificate is valid.
  
  fileName string
  
  Human-readable label given to the file.
  
  requestBinding string
  
  SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.
  
  Values are HTTP-POST or HTTP-REDIRECT.
  
  responseSignatureAlgorithm string
  
  Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.
  
  Values are SHA-1 or SHA-256.
  
  slug string
  
  Custom SSO Url for the identity provider.
  
  ssoDebugEnabled boolean
  
  Flag that indicates whether the identity provider has SSO debug enabled.
  
  ssoUrl string
  
  URL that points to the receiver of the SAML authentication request.
  
  status string
  
  String enum that indicates whether the identity provider is active.
  
  Values are ACTIVE or INACTIVE.
  
  Hide attributes Show attributes
  
  associatedOrgs array[object]
  
  List that contains the connected organization configurations associated with the identity provider.
  
  Hide associatedOrgs attributes Show associatedOrgs attributes object
  
  dataAccessIdentityProviderIds array[string]
  
  The collection of unique ids representing the identity providers that can be used for data access in this organization.
  
  Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.
  
  domainAllowList array[string]
  
  Approved domains that restrict users who can join the organization based on their email address.
  
  domainRestrictionEnabled boolean Required
  
  Value that indicates whether domain restriction is enabled for this connected org.
  
  identityProviderId string
  
  Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^([a-f0-9]{20})$.
  
  orgId string Required
  
  Unique 24-hexadecimal digit string that identifies the connected organization configuration.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  postAuthRoleGrants array[string]
  
  Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
  
  roleMappings array[object]
  
  Role mappings that are configured in this organization.
  
  Mapping settings that link one IdP and MongoDB Cloud.
  
  Hide roleMappings attributes Show roleMappings attributes object
  
  externalGroupName string Required
  
  Unique human-readable label that identifies the identity provider group to which this role mapping applies.
  
  Minimum length is 1, maximum length is 200.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this role mapping.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleAssignments array[object]
  
  Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective orgId. Each element in the array can have a value for orgId or groupId, but not both.
  
  Hide roleAssignments attributes Show roleAssignments attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within roleAssignments can have a value for groupId or orgId, but not both.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  orgId string
  
  Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within roleAssignments can have a value for orgId or groupId, but not both.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  role string
  
  Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.
  
  Organization Roles
  
  ORG_OWNER
  
  ORG_MEMBER
  
  ORG_GROUP_CREATOR
  
  ORG_BILLING_ADMIN
  
  ORG_READ_ONLY
  
  Project Roles
  
  GROUP_CLUSTER_MANAGER
  
  GROUP_DATA_ACCESS_ADMIN
  
  GROUP_DATA_ACCESS_READ_ONLY
  
  GROUP_DATA_ACCESS_READ_WRITE
  
  GROUP_OWNER
  
  GROUP_READ_ONLY
  
  GROUP_SEARCH_INDEX_EDITOR
  
  GROUP_STREAM_PROCESSING_OWNER
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_READ_ONLY, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.
  
  userConflicts array[object]
  
  List that contains the users who have an email address that doesn't match any domain on the allowed list.
  
  MongoDB Cloud user linked to this federated authentication.
  
  Hide userConflicts attributes Show userConflicts attributes object
  
  emailAddress string(email) Required
  
  Email address of the MongoDB Cloud user linked to the federated organization.
  
  federationSettingsId string Required
  
  Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  firstName string Required
  
  First or given name that belongs to the MongoDB Cloud user.
  
  lastName string Required
  
  Last name, family name, or surname that belongs to the MongoDB Cloud user.
  
  userId string
  
  Unique 24-hexadecimal digit string that identifies this user.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  createdAt string(date-time)
  
  Date that the identity provider was created on.
  
  description string
  
  The description of the identity provider.
  
  displayName string
  
  Human-readable label that identifies the identity provider.
  
  id string Required
  
  Unique 24-hexadecimal digit string that identifies the identity provider.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  idpType string
  
  String enum that indicates the type of the identity provider. Default is WORKFORCE.
  
  Values are WORKFORCE or WORKLOAD.
  
  issuerUri string
  
  Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.
  
  oktaIdpId string Required
  
  Legacy 20-hexadecimal digit string that identifies the identity provider.
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^([a-f0-9]{20})$.
  
  protocol string
  
  String enum that indicates the protocol of the identity provider. Either SAML or OIDC.
  
  Values are SAML or OIDC.
  
  updatedAt string(date-time)
  
  Date that the identity provider was last updated on.
  
  associatedDomains array[string]
  
  List that contains the domains associated with the identity provider.
  
  audience string
  
  Identifier of the intended recipient of the token.
  
  authorizationType string
  
  Indicates whether authorization is granted based on group membership or user ID.
  
  Values are GROUP or USER.
  
  clientId string
  
  Client identifier that is assigned to an application by the Identity Provider.
  
  groupsClaim string
  
  Identifier of the claim which contains IdP Group IDs in the token.
  
  requestedScopes array[string]
  
  Scopes that MongoDB applications will request from the authorization endpoint.
  
  userClaim string
  
  Identifier of the claim which contains the user ID in the token.
  
  Hide attributes Show attributes
  
  associatedOrgs array[object]
  
  List that contains the connected organization configurations associated with the identity provider.
  
  Hide associatedOrgs attributes Show associatedOrgs attributes object
  
  dataAccessIdentityProviderIds array[string]
  
  The collection of unique ids representing the identity providers that can be used for data access in this organization.
  
  Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.
  
  domainAllowList array[string]
  
  Approved domains that restrict users who can join the organization based on their email address.
  
  domainRestrictionEnabled boolean Required
  
  Value that indicates whether domain restriction is enabled for this connected org.
  
  identityProviderId string
  
  Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^([a-f0-9]{20})$.
  
  orgId string Required
  
  Unique 24-hexadecimal digit string that identifies the connected organization configuration.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  postAuthRoleGrants array[string]
  
  Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
  
  roleMappings array[object]
  
  Role mappings that are configured in this organization.
  
  Mapping settings that link one IdP and MongoDB Cloud.
  
  Hide roleMappings attributes Show roleMappings attributes object
  
  externalGroupName string Required
  
  Unique human-readable label that identifies the identity provider group to which this role mapping applies.
  
  Minimum length is 1, maximum length is 200.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this role mapping.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleAssignments array[object]
  
  Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective orgId. Each element in the array can have a value for orgId or groupId, but not both.
  
  Hide roleAssignments attributes Show roleAssignments attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within roleAssignments can have a value for groupId or orgId, but not both.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  orgId string
  
  Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within roleAssignments can have a value for orgId or groupId, but not both.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  role string
  
  Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.
  
  Organization Roles
  
  ORG_OWNER
  
  ORG_MEMBER
  
  ORG_GROUP_CREATOR
  
  ORG_BILLING_ADMIN
  
  ORG_READ_ONLY
  
  Project Roles
  
  GROUP_CLUSTER_MANAGER
  
  GROUP_DATA_ACCESS_ADMIN
  
  GROUP_DATA_ACCESS_READ_ONLY
  
  GROUP_DATA_ACCESS_READ_WRITE
  
  GROUP_OWNER
  
  GROUP_READ_ONLY
  
  GROUP_SEARCH_INDEX_EDITOR
  
  GROUP_STREAM_PROCESSING_OWNER
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_READ_ONLY, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.
  
  userConflicts array[object]
  
  List that contains the users who have an email address that doesn't match any domain on the allowed list.
  
  MongoDB Cloud user linked to this federated authentication.
  
  Hide userConflicts attributes Show userConflicts attributes object
  
  emailAddress string(email) Required
  
  Email address of the MongoDB Cloud user linked to the federated organization.
  
  federationSettingsId string Required
  
  Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  firstName string Required
  
  First or given name that belongs to the MongoDB Cloud user.
  
  lastName string Required
  
  Last name, family name, or surname that belongs to the MongoDB Cloud user.
  
  userId string
  
  Unique 24-hexadecimal digit string that identifies this user.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  createdAt string(date-time)
  
  Date that the identity provider was created on.
  
  description string
  
  The description of the identity provider.
  
  displayName string
  
  Human-readable label that identifies the identity provider.
  
  id string Required
  
  Unique 24-hexadecimal digit string that identifies the identity provider.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  idpType string
  
  String enum that indicates the type of the identity provider. Default is WORKFORCE.
  
  Values are WORKFORCE or WORKLOAD.
  
  issuerUri string
  
  Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.
  
  oktaIdpId string Required
  
  Legacy 20-hexadecimal digit string that identifies the identity provider.
  
  Minimum length is 20, maximum length is 20. Format should match the following pattern: ^([a-f0-9]{20})$.
  
  protocol string
  
  String enum that indicates the protocol of the identity provider. Either SAML or OIDC.
  
  Values are SAML or OIDC.
  
  updatedAt string(date-time)
  
  Date that the identity provider was last updated on.
  
  audience string
  
  Identifier of the intended recipient of the token.
  
  authorizationType string
  
  Indicates whether authorization is granted based on group membership or user ID.
  
  Values are GROUP or USER.
  
  groupsClaim string
  
  Identifier of the claim which contains IdP Group IDs in the token.
  
  userClaim string
  
  Identifier of the claim which contains the user ID in the token.
- totalCount integer(int32)
  
  Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false.
  
  Minimum value is 0.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
401 application/json

Unauthorized.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
404 application/json

Not Found.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

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

atlas api federatedAuthentication listIdentityProviders --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListIdentityProvidersApiParams{}
	sdkResp, httpResp, err := client.FederatedAuthenticationApi.
		ListIdentityProvidersWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "associatedOrgs": [
        {
          "dataAccessIdentityProviderIds": [
            "32b6e34b3d91647abb20e7b8"
          ],
          "domainAllowList": [
            "string"
          ],
          "domainRestrictionEnabled": true,
          "identityProviderId": "string",
          "orgId": "32b6e34b3d91647abb20e7b8",
          "postAuthRoleGrants": [
            "ORG_OWNER"
          ],
          "roleMappings": [
            {
              "externalGroupName": "string",
              "id": "32b6e34b3d91647abb20e7b8",
              "roleAssignments": [
                {
                  "groupId": "32b6e34b3d91647abb20e7b8",
                  "orgId": "32b6e34b3d91647abb20e7b8",
                  "role": "ORG_OWNER"
                }
              ]
            }
          ],
          "userConflicts": [
            {
              "emailAddress": "hello@example.com",
              "federationSettingsId": "32b6e34b3d91647abb20e7b8",
              "firstName": "string",
              "lastName": "string",
              "userId": "string"
            }
          ]
        }
      ],
      "createdAt": "2025-05-04T09:42:00Z",
      "description": "string",
      "displayName": "string",
      "id": "32b6e34b3d91647abb20e7b8",
      "idpType": "WORKFORCE",
      "issuerUri": "string",
      "oktaIdpId": "string",
      "protocol": "SAML",
      "updatedAt": "2025-05-04T09:42:00Z",
      "acsUrl": "string",
      "associatedDomains": [
        "string"
      ],
      "audienceUri": "string",
      "pemFileInfo": {
        "certificates": [
          {
            "notAfter": "2025-05-04T09:42:00Z",
            "notBefore": "2025-05-04T09:42:00Z"
          }
        ],
        "fileName": "string"
      },
      "requestBinding": "HTTP-POST",
      "responseSignatureAlgorithm": "SHA-1",
      "slug": "string",
      "ssoDebugEnabled": true,
      "ssoUrl": "string",
      "status": "ACTIVE"
    }
  ],
  "totalCount": 42
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}