返回所有角色映射
2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
- 用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。
- 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。
federationSettings资源允许您从指定联合中的指定组织返回所有角色映射。
所需角色
您必须具有Organization Owner角色才能调用此端点。
Resource
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings
请求
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
FEDERATION-SETTINGS-ID | 字符串 | 唯一的 24 位十六进制数字字符串，用于标识联合身份验证配置。 |
ORG-ID | 字符串 | 唯一的 24 位十六进制数字字符串，用于标识连接的组织。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
links
results
一组文档，每个文档代表一个角色映射。
名称 | 类型 | 说明 |
|---|---|---|
externalGroupName | 字符串 | 唯一的人类可读标签，用于标识与角色映射关联的提供商群组。 |
id | 字符串 | 唯一的 24 位十六进制数字字符串，用于标识角色映射。 |
roleAssignments | 阵列 | 包含与每个角色关联的项目和组织的唯一标识符的列表。 |
roleAssignments.groupId | 字符串 | 唯一的 24 位十六进制数字字符串，用于标识角色适用的项目。 |
roleAssignments.orgId | 字符串 | 唯一的 24 位十六进制数字字符串，用于标识角色适用的组织。 |
roleAssignments.role | 字符串 | 用于标识角色的人类可读标签。 |
totalCount
结果集中的项目总数。 如果对整个结果集进行分页，则该值可能大于results数组中的对象数。
例子
请求
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/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings"
响应
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "externalGroupName": "autocomplete-highlight", "id": "61d88e15e6cc044270a36fce", "roleAssignments": [ { "groupId": null, "orgId": "{ORG-ID}", "role": "ORG_OWNER" }, { "groupId": "{GROUP-ID}", "orgId": null, "role": "GROUP_OWNER" } ] } ], "totalCount": 1 }