返回所有连接的组织

在此页面上

所需角色

Resource
请求路径参数
请求查询参数
请求正文参数
响应
响应文档
结果嵌入式文档
请求示例
响应示例

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth2.0 身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

federationSettings资源允许您返回所有已连接的组织以进行联合身份验证配置。

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

所需角色

您必须在联合配置中具有至少一个已连接组织的Organization Owner角色，才能调用此端点。

Resource

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/

请求路径参数

名称	类型	说明
`FEDERATION-SETTINGS-ID`	字符串	唯一的 24 位十六进制数字字符串，用于标识联合身份验证配置。

请求查询参数

以下查询参数为可选参数：

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印的标志格式。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点，`content` 对象是一个信封。Cloud Manager 将 `status` 字段添加到响应正文。	`false`
backupJobsEnabledOnly	布尔	Optional	指示是否从响应中排除未启用备份数据库的守护进程的标志。将其设置为`false`以包含将`backupJobsEnabled`标志设置为`false`的守护进程配置。	`true`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应文档

响应JSON文档包括结果对象数组、链接对象数组和检索到的结果对象总数。

名称	类型	说明
结果	对象数组	结果“嵌入式文档”部分详细介绍了每个项目的一个对象。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
总计数	整型	结果集中的项目总数。如果对整个结果集进行分页，则它可能大于结果数组中的对象数。

结果嵌入式文档

result数组中的每个文档都包含每个已连接组织的联合身份验证配置。

名称	类型	说明
`domainAllowList`	阵列	包含组织用户可以登录的已批准域的列表。
`domainRestrictionEnabled`	布尔	指示是否为连接的组织启用域限制的标志。 `userConflicts` 当`null` 时返回`"domainRestrictionEnabled": false` 。
`identityProviderId`	字符串	唯一的 20 位十六进制数字字符串，用于标识与连接组织关联的身份提供商。
`orgId`	字符串	唯一的 24 位十六进制数字字符串，用于标识连接的组织。
`postAuthRoleGrants`	阵列	列表，其中包含授予通过已连接组织中的 IdP 进行身份验证的用户的默认角色。
`roleMappings`	阵列	包含此组织中配置的角色映射的列表。
`userConflicts`	阵列	包含与允许列表上的任何域都不匹配的用户名的列表。 `userConflicts` 当`null` 时返回`"domainRestrictionEnabled": false` 。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

响应示例

{
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}

后退

返回配置

来年

返回组织