公开预览版：请在以下位置提供反馈：删除指定联合中的一个身份提供商。
要使用该资源，请求的 API 密钥必须具有连接的组织之一的组织所有者角色。
注意：如果身份提供程序具有任何连接的组织，对该资源的请求将会失败。在删除身份提供程序之前，请断开连接所有组织，并确认您的帐户中没有任何组织使用该身份提供程序。要了解更多信息，请参阅管理联合身份验证的组织映射。
1此命令是自动生成的，对应于:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2 /# 标签/Federated-身份验证/操作/deleteIdentityProvider。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api federatedAuthentication deleteIdentityProvider [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--federationSettingsId | 字符串 | true | 用于标识联合的唯一的 24 位十六进制数字字符串。 |
-h，--help | false | deleteIdentityProvider 帮助 | |
--identityProviderId | 字符串 | true | 唯一的 24 位十六进制数字串，用于标识要连接的身份提供程序。 |
--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。 |
示例
运行以下命令。
atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8