1 つのフェデレーション設定に接続された 1 つの組織構成を更新します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です（フィードバックでフィードバックを提供してくださいフォーラム/930808-Atlas-cli）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
構文
atlas federatedAuthentication federationSettings connectedOrgConfigs update [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--federationSettingsId | string | true | フェデレーション設定を識別する一意な 24 桁の 16 進数のstring 。 |
--file | string | true | 接続された組織の構成を定義するJSON構成ファイルへのパス。注: JSONファイル内のサポートされていないフィールドは無視されます。接続済み組織の構成ファイル形式の詳細については、https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-updateconnectedorgconfig. のリクエスト本文を参照してください。 |
-h, --help | false | 更新のヘルプ | |
--orgId | string | false | 使用する組織ID。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
-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 を参照してください。 |
例
# Update the connected orgs config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json atlas federatedAuthentication federationSettings connectedOrgConfigs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json