返回一个组织的联合配置
2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
federationSettings资源允许您返回一个组织的联合身份验证配置。
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
所需角色
您必须具有Organization Owner角色才能调用此端点。
Resource
GET /orgs/{ORG-ID}/federationSettings
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 标识组织的唯一 24 位十六进制数字字符串。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 |
| ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
|---|---|---|
| 字符串数组 | 包含与组织身份提供程序关联的域的列表。 |
| 布尔 | 指示该组织是否配置角色映射的标志。 要了解有关角色映射的更多信息，请参阅管理 Cloud Manager 角色到 IdP 群组的映射。 |
| 字符串 | 标识此联合的唯一 24 位十六进制数字字符串。 |
| 字符串 | 唯一的 20 位十六进制数字字符串，用于标识连接到该组织的身份提供商。 |
| 字符串 | 指示身份提供程序是否处于活动状态的值。 如果提供商处于活动状态，则 Cloud Manager 返回 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/federationSettings"
响应示例
{ "federatedDomains": [ "example.com" ], "hasRoleMappings": false, "id": "5e8cc670a16506712e0b1e95", "identityProviderId": "0oa8i0grsgbwDiIyw453", "identityProviderStatus": "INACTIVE" }