Atlas API federatedAuthentication updateIdentityProvider

Atlas CLI对使用Atlas Administration API运行命令的支持处于预览状态。在预览期间，功能和相应的文档可能随时更改。要学习；了解详情，请参阅预览功能。

要使用该资源，请求的 API 密钥必须具有连接的组织之一的组织所有者角色。

注意：更改授权类型和/或更新授权声明可能会阻止当前用户和/或群组访问数据库。

此命令是自动生成的，对应于 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Federated-Authentication/operation/updateIdentityProvider。

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

语法

命令语法

atlas api federatedAuthentication updateIdentityProvider [options]

选项

名称	类型	必需	说明
--envelope	envelope	false	指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。
--federationSettingsId	字符串	true	用于标识联合的唯一的 24 位十六进制数字字符串。
--file	字符串	false	API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。
-h，--help		false	updateIdentityProvider 帮助
--identityProviderId	字符串	true	标识要连接的身份提供者的唯一字符串。如果使用在 11-15-2023 之前的 API 版本，请使用旧版 20-十六进制数字 ID。点击已配置身份提供者的 IdP ID 行中的信息图标，即可在联合管理控制台>身份提供者选项卡中找到该 ID。对于所有其他版本，请使用 24 位十六进制数字 id。
--output	字符串	false	首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。
--output-file	字符串	false	要将API输出写入其中的文件。当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志
--version	字符串	false	进行API调用时要使用的API版本 [选项："2023-11-15"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-11-15"。

继承选项

名称	类型	必需	说明
-P, --profile	字符串	false	要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。