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

atlas api mongoDbCloudUsers listOrgUsers

指定された組織に関連付けられている、保留中の MongoDB Cloud ユーザーおよびアクティブな MongoDB Cloud ユーザーの詳細を返します。

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

このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに組織メンバーのロールが必要です。

注: このリソースは、非推奨の「1 人の MongoDB Cloud ユーザーを 1 つのプロジェクトに招待する」エンドポイントとなる接続されたデバイスを介して招待されたユーザーの詳細を表示するために使用することはできません。

注意: 保留中のユーザーとアクティブなユーザーの両方を返すには、v2-{2025-02-19} 以降を使用してください。非推奨のバージョンを使用している場合、アクティブなユーザーのみが帰されます。

このコマンドは自動生成され、1:1 と Atlas API エンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgusers.

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

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

-- envelope

envelope

false

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

-h, --help

false

listOrgUsers のヘルプ

--includeCount

false

レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。

--itemsPerPage

整数

false

レスポンスが返す 1 ページあたりのアイテムの数。

--orgId

string

true

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

--orgMemergeStatus

string

false

ユーザーをフィルターするための組織メンバーシップ ステータス。このパラメータを除外すると、このリソースは保留中のユーザーとアクティブなユーザーの両方を返します。非推奨バージョンではサポートされていません。

-o, --output

string

false

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

-- outputFile

string

false

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

--pageNum

整数

false

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

--pretty

false

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

--username

string

false

ユーザーをフィルターするためのメール アドレスです。非推奨バージョンではサポートされていません。

--version

string

false

API 呼び出しで使用する API バージョン [options: "2023-01-01", "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 listOrgUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE