指定された ID プロバイダーをフェデレーション設定から削除します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です（フィードバックでフィードバックを提供してくださいフォーラム/930808-Atlas-cli）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
このコマンドを使用するには、ユーザー アカウントまたは、組織所有者ロールの API キーで認証する必要があります。
構文
atlas federatedAuthentication federationSettings identityProvider delete <identityProviderId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
identityProviderId | string | true | identityProvider の ID。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--federationSettingsId | string | true | フェデレーション設定を識別する一意な 24 桁の 16 進数のstring 。 |
--force | false | 要求されたアクションを続行する前に確認プロンプトをスキップするかどうかを示すフラグ。 | |
-h, --help | false | 削除のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Identity provider '<Name>' deleted
例
# elete the identity provider with ID aa2223b25a115342acc1f108 from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. atlas federatedAuthentication federationSettings identityProvider delete aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa