更新一个互联组织

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

基本 URL： https://cloud.mongodb.com/api/public/v1.0

所需角色

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

Resource

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

请求路径参数

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

请求查询参数

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

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否应采用 prettyprint 格式的标记。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

名称	类型	必要性	说明
`domainAllowList`	阵列	Optional	包含组织用户可以登录的已批准域的列表。如果您在请求中提供`domainAllowList`字段，则您提供的数组将替换当前的`domainAllowList` 。
`domainRestrictionEnabled`	布尔	必需	指示是否为连接的组织启用域限制的标志。
`identityProviderId`	字符串	必需	唯一的 20 位十六进制数字字符串，用于标识与连接组织关联的身份提供商。如果省略或值为`null` ，MongoDB Cloud 会断开`orgId`指定的组织与IdP的连接。
`orgId`	字符串	必需	唯一的 24 位十六进制数字字符串，用于标识连接的组织。
`postAuthRoleGrants`	阵列	Optional	列表，其中包含授予通过已连接组织中的 IdP 进行身份验证的用户的默认角色。如果您在请求中提供`postAuthRoleGrants`字段，则您提供的数组将替换当前的`postAuthRoleGrants` 。
`roleMappings`	阵列	Optional	包含此组织中配置的角色映射的列表。如果您在请求中提供`roleMappings`字段，则您提供的数组将替换当前的`roleMappings` 。

响应

名称	类型	说明
`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 PATCH "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}" \     --data '       {         "domainRestrictionEnabled": false,         "identityProviderId": "0oa7i0grsgbwJiIyw357",         "orgId": "5df7a168f10fab3a149357fb",         "roleMappings": [           {             "externalGroupName": "example",             "id": "61e89721b827b56c845ff44c",             "roleAssignments": [               {                 "groupId": null,                 "orgId": "5df7a168f10fab3a149357fb",                 "role": "ORG_OWNER"               }             ]           }         ]       }'

响应示例

{  "domainAllowList": [],  "domainRestrictionEnabled": false,  "identityProviderId": "0oa7i0grsgbwJiIyw357",  "orgId": "5df7a168f10fab3a149357fb",  "postAuthRoleGrants": [    "ORG_OWNER"  ],  "roleMappings": [    {      "externalGroupName": "example",      "id": "61e89721b827b56c845ff44c",      "roleAssignments": [        {          "groupId": null,          "orgId": "5df7a168f10fab3a149357fb",          "role": "ORG_OWNER"        }      ]    }  ],  "userConflicts": null}