1 つのフェデレーションを削除
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth 2.0認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービス アカウントを作成します。
federationSettingsリソースを使用すると、1 つのフェデレーションと、フェデレーションが記述する IdP やドメインを含むすべての関連データを削除できます。
重要
フェデレーション内に接続されている組織が複数ある場合、このリソースへのリクエストは失敗します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
必須のロール
このエンドポイントを呼び出すには、最後に接続された組織のOrganization Ownerロールが必要です。
Resource
DELETE /federationSettings/{FEDERATION-SETTINGS-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
FEDERATION-SETTINGS-ID | string | フェデレーション認証構成を識別する一意な 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントは、レスポンス本体を返しません。
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}"
応答例
このエンドポイントは、レスポンス本体を返しません。