パブリック プレビュー: でフィードバックを提供してください: フェデレーション設定インスタンスと、IdPやドメインを含むすべての関連データを削除します。
このリソースを使用するには、リクエスト元の API キーが、最後に接続された組織の組織オーナーロールを持っている必要があります。注: フェデレーション内に接続されている組織が複数ある場合、このリソースへのリクエストは失敗します。
1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Federated- に対応します認証/操作/deleteFederationApp 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api federatedAuthentication deleteFederationApp [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--federationSettingsId | string | true | フェデレーションを識別するユニークな 24 桁の 16 進数文字列。 |
-h, --help | false | deleteFederationApp のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |
例
以下の コマンドを実行します。
atlas api federatedAuthentication deleteFederationApp --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e