Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
联合身份验证

返回一个连接的组织

在此页面上

  • 所需角色
  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例

federationSettings资源允许您为联合身份验证配置返回一个连接的组织。

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

所需角色

您必须具有Organization Owner角色才能调用此端点。

Resource

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

请求路径参数

名称
类型
说明

FEDERATION-SETTINGS-ID

字符串

唯一的 24 位十六进制数字字符串，用于标识联合身份验证配置。

ORG-ID

字符串

唯一的 24 位十六进制数字字符串，用于标识连接的组织。

请求查询参数

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

指示响应正文是否应采用 美观打印 的标志 格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

请求正文参数

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

响应

名称
类型
说明

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/{ORG-ID}"

响应示例

{
 "domainAllowList": [],
 "domainRestrictionEnabled": false,
 "identityProviderId": null,
 "orgId": "5f86fb11e0079069c9ec3132",
 "postAuthRoleGrants": [],
 "roleMappings": [],
 "userConflicts": null
}

后退

返回所有组织

来年

更新组织