删除联合设置实例和所有关联数据，包括身份提供者和域。
atlas api 子命令是从MongoDB Atlas Admin API自动生成的，并提供对 Admin API的全面覆盖。 Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
要使用此资源，请求的服务帐户或 API 密钥必须在最后剩余的连接组织中具有“组织所有者”角色。注意：如果联合中有多个连接的组织，则对该资源的请求将会失败。
1此命令是自动生成的，对应:1 与Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/ operation-deletefederationsetting。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api federatedAuthentication deleteFederationSetting [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--federationSettingsId | 字符串 | true | 用于标识联合的唯一的 24 位十六进制数字字符串。 |
-h，--help | false | deleteFederationSetting 帮助 | |
-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。 |
示例
atlas api federatedAuthentication deleteFederationSetting --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e