AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu

atlas api mongoDbCloudUsers getGroupUser

指定された MongoDB Cloud プロジェクトのコンテキスト内で、指定された MongoDB Cloud ユーザーに関する情報を返します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin 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-getgroupuser

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

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

-- envelope

envelope

false

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

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

-h, --help

false

getGroupUser のヘルプ

--orgMembershipStatuses

アクティブ

false

ユーザーをフィルターするための組織メンバーシップ ステータス。このパラメータは複数回指定できます。許可されている値: ACTIVE、PENDINGINVITATION_EXPIREDINVITATION_REJECTED。このパラメータを除外すると、このリソースは ACTIVE と PENDING のユーザーを返します。非推奨バージョンではサポートされていません。

-o, --output

string

false

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

-- outputFile

string

false

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

--pretty

false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

--userId

userId

true

プロジェクト内の保留中のユーザーまたはアクティブなユーザーを識別する一意の 24 桁の 16 進数文字列。ユーザーの userId を検索したり、組織内のユーザーのステータスを確認したりする必要がある場合は、「1つのプロジェクトのすべてのMongoDB Cloud ユーザーを返す」リソースを使用し、usernameでフィルターします。

--version

string

false

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

名前
タイプ
必須
説明

-P, --profile

string

false

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

atlas api mongoDbCloudUsers getGroupUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId]