AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

Atlas APIフェデレーティッド認証 getConnectedOrgConfig

指定されたフェデレーションから指定された接続済み組織の構成を返します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。

このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーが接続済み組織の組織オーナーロールを持っている必要があります。

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingconnectedorgconfig.

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

コマンド構文
atlas api federatedAuthentication getConnectedOrgConfig [options]
名前
タイプ
必須
説明

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--federationSettingsId

string

true

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

-h, --help

false

getConnectedOrgConfig のヘルプ

--orgId

string

true

返却対象の接続済み組織の構成を識別するユニークな 24 桁の 16 進数文字列。

-o, --output

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- outputFile

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--version

string

false

Atlas API エンドポイントを呼び出すときに使用する API バージョン [オプション: "2023-01-01"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの api_version 構成値が設定されている場合はその値がデフォルトになります。この値のデフォルトは "2023-01-01" です。

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルについて学ぶには、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。

atlas api federatedAuthentication getConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8