删除一个联合
2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
- 用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。
- 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。
federationSettings资源允许您删除一个联合和所有关联数据，包括身份提供商和联合描述的域。
重要
如果联合中有多个连接的组织，则对该资源的请求将失败。
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
所需角色
您必须在上次连接的组织中具有Organization Owner角色才能调用此端点。
Resource
DELETE /federationSettings/{FEDERATION-SETTINGS-ID}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
FEDERATION-SETTINGS-ID | 字符串 | 唯一的 24 位十六进制数字字符串，用于标识联合身份验证配置。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
此端点不返回响应正文。
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}"
响应示例
此端点不返回响应正文。