パブリック プレビュー:フィードバックを提供してください : 指定されたプロジェクトのコンテキスト内で、指定されたMongoDB Cloud ユーザーに関する情報を返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトの読み取り専用ロールが必要です。
注：このリソースは、 MongoDB Cloud の人間ユーザーに関する情報を取得するためにのみ使用できます。APIキーに関する情報を返すには、 1 つの組織を返すAPIキー エンドポイントを使用します。
注：このリソースは、非推奨の 1 人のMongoDB Cloud ユーザーを 1 つのプロジェクトに招待 エンドポイントによって招待された保留中のユーザーに関する情報を返しません。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectuser 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api mongoDbCloudUsers getProjectUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | getProjectUser のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--userId | string | true | プロジェクト内の保留中のユーザーまたはアクティブなユーザーを識別するユニークな 24 桁の 16 進数の文字列。ユーザーの userId を検索したり、組織内のユーザーのステータスを確認したりする必要がある場合は、「1 つの MongoDB Cloud プロジェクト内のすべての MongoDB Cloud ユーザーを返す」リソースを使用し、ユーザー名でフィルターします。 |
--version | string | false | API 呼び出し [options: "2025-02-19"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2025-02-19" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |
例
atlas api mongoDbCloudUsers getProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId]