返回一个角色映射
federationSettings
资源允许您从指定联合中的指定组织返回一个角色映射。
基本 URL: https://cloud.mongodb.com/api/public/v 1.0
所需角色
您必须具有Organization Owner
角色才能调用此端点。
Resource
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}
请求路径参数
名称 | 类型 | 说明 |
---|---|---|
| 字符串 | 唯一的 24 位十六进制数字字符串,用于标识联合身份验证配置。 |
| 字符串 | 唯一的 24 位十六进制数字字符串,用于标识连接的组织。 |
| 字符串 | 唯一的 24 位十六进制数字字符串,用于标识角色映射。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 |
| ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
---|---|---|
| 字符串 | 唯一的人类可读标签,用于标识与角色映射关联的提供商群组。 |
| 字符串 | 唯一的 24 位十六进制数字字符串,用于标识角色映射。 |
| 阵列 | 包含与每个角色关联的项目和组织的唯一标识符的列表。 |
| 字符串 | 唯一的 24 位十六进制数字字符串,用于标识角色适用的项目。 |
| 字符串 | 唯一的 24 位十六进制数字字符串,用于标识角色适用的组织。 |
| 字符串 | 用于标识角色的人类可读标签。 |
请求示例
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/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}"
响应示例
{ "externalGroupName": "autocomplete-highlight", "id": "61d88e15e6cc044270a36fce", "roleAssignments": [ { "groupId": null, "orgId": "5f86fb11e0079069c9ec3132", "role": "ORG_OWNER" }, { "groupId": "5f86fb2ff9c4e56d39502559", "orgId": null, "role": "GROUP_OWNER" } ] }