返回一个联合中的所有身份提供程序

获取 /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders
服务账户 DigestAuth

返回指定联合中具有提供的协议和类型的所有身份提供程序。如果未指定协议，则仅返回 SAML 身份提供程序。如果未指定 idpType，则仅返回 WORKFORCE 身份提供程序。要使用此资源，请求的服务帐户或 API 密钥必须在连接的组织之一中具有“组织所有者”角色。

路径参数

  • federationSettingsId 字符串 必需

    用于标识联合的唯一的 24 位十六进制数字字符串。

    格式应符合以下模式：^([a-f0-9]{24})$。

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false 。

  • itemsPerPage 整型

    响应每页返回的列项数。

    最小值为 1，最大值为 500。默认值为 100。

  • pageNum 整型

    显示响应返回的当前总对象集的页面编号。

    最小值为 1。默认值为 1。

  • protocol array[string]

    目标身份提供程序的协议。

    值为 SAML 或 OIDC。默认值为 SAML。

  • idpType array[string]

    目标身份提供程序的类型。

    值为 WORKFORCE 或 WORKLOAD。默认值为 WORKFORCE。

响应

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

    正常

    隐藏响应属性 显示响应属性 对象
    • 链接 大量[对象]

      点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

      Web 链接规范 (RFC 5988)
      隐藏链接属性 显示链接属性 对象
      • href 字符串

        统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

      • rel 字符串

        统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

    • 结果 大量[对象]

      MongoDB Cloud 在完成此请求时提供的返回文档列表。

      以下之一：
      FederationSamlIdentityProvider对象 FederationOidcWorkforceIdentityProvider对象 FederationOidcWorkloadIdentityProvider对象
    • 总计数 integer(int32)

      可用文档总数。如果 includeCount设立为 false，MongoDB Cloud 会忽略此值。总数为估计值，可能不准确。

      最小值为 0。
  • 400 application/json

    错误请求。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
GET /api/atlas/v2 /federationSettings/{federationSettingsId}/identityProviders 
atlas api federatedAuthentication listFederationSettingIdentityProviders --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.ListFederationSettingIdentityProvidersApiParams{}
	sdkResp, httpResp, err := client.FederatedAuthenticationApi.
		ListFederationSettingIdentityProvidersWithParams(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"
响应示例 (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "associatedOrgs": [
        {
          "dataAccessIdentityProviderIds": [
            "string"
          ],
          "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": "32b6e34b3d91647abb20e7b8"
            }
          ]
        }
      ],
      "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
}
响应示例 (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"
}
响应示例 (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"
}
响应示例 (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (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"
}
响应示例 (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"
}