从一个联合返回所有组织配置

获取 /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs

服务账户 DigestAuth

返回指定联合中所有已连接的组织配置。要使用此资源，请求的服务帐户或 API 密钥必须在一个已连接的组织中具有“组织所有者”角色。

路径参数

federationSettingsId 字符串必需

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

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

查询参数

envelope 布尔

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

默认值为false 。
itemsPerPage 整型

响应每页返回的列项数。

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

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

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

响应

200 application/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 在完成此请求时提供的返回文档列表。
  
  隐藏结果属性显示结果属性对象
  
  dataAccessIdentityProviderIds array[string]
  
  代表可用于该组织数据访问的身份提供者的唯一 ID 集合。
  
  domainAllowList array[string]
  
  根据电子邮件地址限制用户加入组织的批准域。
  
  domainRestrictionEnabled 布尔必需
  
  指示是否为此连接的组织启用域限制的值。
  
  identityProviderId 字符串
  
  旧有的 20 位十六进制数字字符串，用于标识此已连接的组织配置所关联的用户界面访问身份提供者。通过单击已配置身份提供者的 IdP ID 行中的信息图标，可以在“联合管理控制台” > “身份提供者”选项卡中找到此 ID。
  
  格式应符合以下模式：^([a-f0-9]{20})$。
  
  orgId 字符串必需
  
  唯一的 24 位十六进制数字字符串，用于标识连接的组织配置。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
  
  postAuthRoleGrants array[string]
  
  身份验证后向该组织中的用户授予的 Atlas 角色。角色是一个人类可读的标签，用于标识 MongoDB Cloud 授予特定 MongoDB Cloud 用户的权限集合。这些角色只能是组织特定的角色。
  
  取值为 ORG_OWNER、ORG_MEMBER、ORG_GROUP_CREATOR、ORG_BILLING_ADMIN、ORG_BILLING_READ_ONLY、ORG_STREAM_PROCESSING_ADMIN 或 ORG_READ_ONLY。
  
  roleMappings 大量[对象]
  
  在此组织中配置的角色映射。
  
  链接一个 IdP 和MongoDB Cloud 的映射设置。
  
  隐藏 roleMappings 属性显示 roleMappings 属性对象
  
  externalGroupName 字符串必需
  
  唯一的人类可读标签，用于标识应用此角色映射的身份提供程序群组。
  
  最小长度为 1，最大长度为 200。
  
  id 字符串
  
  标识此角色映射的唯一 24-十六进制数字字符串。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
  
  roleAssignments 大量[对象]
  
  Atlas 角色以及与每个角色关联的组和组织的唯一标识符。数组中必须至少有一个元素包含“组织”角色及其相应的 orgId。数组中的每个元素都可以具有 orgId 或 groupId 的值，但不能同时具有两者的值。
  
  隐藏 roleAssignments 属性显示 roleAssignments 属性对象
  
  groupId 字符串
  
  24唯一的 -十六进制数字字符串，用于标识此角色所属的项目。 roleAssignments 中的每个元素都可以具有 groupId 或 orgId 值，但不能同时具有两者。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
  
  orgId 字符串
  
  24唯一的 -十六进制数字字符串，用于标识此角色所属的组织。 roleAssignments 中的每个元素都可以具有 orgId 或 groupId 值，但不能同时具有两者。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
  
  角色字符串
  
  人类可读标签，用于标识MongoDB Cloud 授予特定API密钥、 MongoDB Cloud 用户或MongoDB Cloud团队的权限集合。这些角色包括组织级角色和项目级角色。
  
  值为 ORG_OWNER、ORG_MEMBER、ORG_GROUP_CREATOR、ORG_BILLING_ADMIN、ORG_BILLING_READ_ONLY、ORG_STREAM_PROCESSING_ADMIN、ORG_READ_ONLY、GROUP_BACKUP_MANAGER、GROUP_CLUSTER_MANAGER、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、 GROUP_DATABASE_ACCESS_ADMIN、GROUP_OBSERVABILITY_VIEWER、GROUP_OWNER、GROUP_READ_ONLY、GROUP_SEARCH_INDEX_EDITOR 或 GROUP_STREAM_PROCESSING_OWNER。
  
  userConflicts 大量[对象]
  
  包含电子邮件地址与允许列表中的任何域都不匹配的用户的列表。
  
  链接到此联合身份验证的MongoDB Cloud 用户。
  
  隐藏 userConflicts 属性显示 userConflicts 属性对象
  
  邮箱 string(电子邮件) 必需
  
  关联到联合组织的MongoDB Cloud 用户的电子邮件解决。
  
  federationSettingsId 字符串必需
  
  唯一的 24-十六进制数字字符串，用于标识此MongoDB Cloud 用户所属的联合。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
  
  名字符串必需
  
  属于 MongoDB Cloud 用户的名或姓。
  
  姓字符串必需
  
  属于 MongoDB Cloud 用户的姓氏。
  
  用户 ID 字符串
  
  用于标识此用户的唯一的 24 位十六进制数字字符串。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- 总计数 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/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/federationSettings/55fa922fb343282757d9554e/connectedOrgConfigs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

响应示例 (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
        }
      ]
    }
  ],
  "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"
}