指定した組織への保留中の招待の詳細を返します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに Organization Owner ロールが必要です。
注意: 招待マネジメント API は非推奨です。保留中のユーザーを返すには、「1 つの組織内の 1 人のMongoDB Cloud ユーザーを返す」を使用してください。
このコマンドは自動生成され、1:1 と Atlas API のエンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvite. に対応しています。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api organizations getOrgInvite [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
-h, --help | false | getOrgInvite のヘルプ | |
--invitationId | string | true | 招待を識別するユニークな 24 桁の 16 進数の文字列。 |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。 |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | 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://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
atlas api organizations getOrgInvite --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61