実験的な : 指定されたフェデレーションから、接続された組織構成を 1 つ更新します。
このリソースを使用するには、リクエストするAPIキーに組織所有者のロールが必要です。注 :組織構成にIdPが関連付けられていない場合、このリソースを使用してロール マッピングを更新したり、認可ロールの付与を書き込みしたりすることはできません。注: domainRestrictionEnabledフィールドは、リクエストで提供されなければ、デフォルトで false に設定されます。注: identityProviderIdフィールドが提供されない場合、組織とIdPは切断されます。注: dataAccessIdentityProviderIdsフィールドから欠落している現在接続されているデータアクセスID プロバイダーは切断されます。このコマンドは、OpsID: 'updateConnectedOrgConfig' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/フェデレーティッド認証/ 操作/updateConnectedOrgConfig
構文
atlas api federatedAuthentication updateConnectedOrgConfig [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--federationSettingsId | string | true | フェデレーションを識別する一意の 24 桁の 16 進数文字列 |
--file | string | false | APIリクエストの内容を含むファイルへのパス |
-h, --help | false | updateConnectedOrgConfig のヘルプ | |
--orgId | string | true | 更新対象の接続済み組織の構成を識別する一意な 24 桁の 16 進数文字列 |
--出力 | 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. を参照してください。 |