実験的な : フェデレーション設定インスタンスと、IdPやドメインを含むすべての関連データを削除します。
このリソースを使用するには、リクエスト元のAPIキーが、最後に接続された組織の組織オーナーロールを持っている必要があります。注: フェデレーション内に接続されている組織が複数ある場合、このリソースへのリクエストは失敗します。このコマンドは、OpsID: 'deleteFederationApp' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/フェデレーティッド認証/ /deleteFederationApp操作
構文
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://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |