Atlas API federatedAuthentication updateConnectedOrgConfig

Atlas Administration APIでコマンドを実行中ための Atlas CLI サポートはプレビュー段階です。機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。詳しくは、プレビュー機能を参照してください。

パブリックプレビュー: にフィードバックを提供してください: 指定されたフェデレーションから、接続された組織構成を 1 つ更新します。

このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

注: 組織構成に IdP が関連付けられていない場合、このリソースを使用してロールマッピングを更新したり、承認ロールの付与を書き込みしたりすることはできません。

注: domainRestrictionEnabled フィールドは、リクエストで提供されなければ、デフォルトで false に設定されます。

注: identityProviderId フィールドが提供されない場合、組織と IdP は切断されます。

注: 現在接続されているデータアクセス IdP が dataAccessIdentityProviderIds フィールドに含まれていない場合は、接続が解除されます。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Federated- に対応します認証/操作/updateConnectedOrgConfig。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

構文

コマンド構文

atlas api federatedAuthentication updateConnectedOrgConfig [options]

オプション

名前	タイプ	必須	説明
-- envelope	envelope	false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。
--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. を参照してください。