对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

Atlas API federatedAuthentication updateConnectedOrgConfig

从指定联合中更新一个已连接的组织配置。

atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。

要使用此资源,请求的服务账户或 API 密钥必须具有“组织所有者”角色。

请注意,如果组织配置中没有关联身份提供商,则无法使用此资源更新角色映射或发布授权角色授予。

注意:如果请求中未提供,则 domainRestrictionEnabled 字段默认为 false。

注意:如果未提供 identityProviderId 字段,则会断开组织和身份供应商的连接。

注意:如果 dataAccessIdentityProviderIds 字段中缺少当前已连接的数据访问身份提供商,则会断开连接。

此命令是自动生成的,对应于 1:1 和 Atlas API 终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingconnectedorgconfig.

有关更多信息和示例,请参阅上面链接的参考API文档。

命令语法
atlas api federatedAuthentication updateConnectedOrgConfig [options]
名称
类型
必需
说明

--envelope

envelope

false

指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。

--federationSettingsId

字符串

true

用于标识联合的唯一的 24 位十六进制数字字符串。

--file

字符串

false

API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一,但不能同时提供两者。

-h,--help

false

updateConnectedOrgConfig 帮助

--orgId

字符串

true

唯一的 24 位十六进制数字字符串,用于标识要更新的连接组织配置。

-o, --output

字符串

false

首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。

--outputFile

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志

--version

字符串

false

进行API调用时要使用的API版本 [选项:"2023-01-01"],默认为最新版本或配置文件 api_version 配置值(如果设立了此值),默认为 "2023-01-01"。

名称
类型
必需
说明

-P, --profile

字符串

false

要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.