atlas api mongoDbCloudUsers listProjectUsers

envelope

false

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

" flattenTeams" : false

false

返されるリストに、このプロジェクトでロールを持つチームに所属するユーザーを含めるかどうかを示すフラグ。プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。" flattenTeams" : false の場合、このリソースはプロジェクト内でのロールがあるユーザーのみを返します。"flattenTeams" : true の場合、このリソースはプロジェクト内でのロールがあるユーザーと、プロジェクト内でのロールがあるチームに所属するユーザーの両方を返します。

string

true

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

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

false

listProjectUsers のヘルプ

false

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

"includeOrgUsers":false

false

返されるリストに、プロジェクトへの暗黙的なアクセス権を持つユーザー、組織所有者、組織の読み取り専用ロールを含めるかどうかを示すフラグ。プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。"includeOrgUsers":false の場合、このリソースはプロジェクト内でのロールがあるユーザーのみを返します。"includeOrgUsers": true の場合、このリソースはプロジェクト内でのロールがある持つユーザーと、組織ロールを通じてプロジェクトに暗黙的にアクセスできるユーザーの両方を返します。

整数

false

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

string

false

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

string

false

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

string

false

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

整数

false

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

false

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

string

false

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

string

false

API 呼び出しで使用する API バージョン [options: "2023-01-01", "2025-02-19"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2025-02-19" になります。