1 つのプロジェクトのすべての MongoDB Cloud ユーザーを返す
指定されたプロジェクト内のすべてのユーザーに関する詳細を返します。ユーザーは組織に属しています。このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトの読み取り専用ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。 -
レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。
デフォルト値は
true
です。 -
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は
1
、最大値は500
です。デフォルト値は100
です。 -
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は
1
です。デフォルト値は1
です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint -
返されるリストに、このプロジェクトでロールを持つチームに所属するユーザーを含めるかどうかを示すフラグ。プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。
"flattenTeams" : false
の場合、このリソースはプロジェクト内でのロールがあるユーザーのみを返します。"flattenTeams" : true
の場合、このリソースはプロジェクト内でのロールがあるユーザーと、プロジェクト内でのロールがあるチームに所属するユーザーの両方を返します。デフォルト値は
false
です。 -
返されるリストに、プロジェクトへの暗黙的なアクセス権を持つユーザー、組織所有者、組織の読み取り専用ロールを含めるかどうかを示すフラグ。プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。
"includeOrgUsers": false
の場合、このリソースはプロジェクト内でのロールがあるユーザーのみを返します。"includeOrgUsers": true
の場合、このリソースはプロジェクト内でのロールがある持つユーザーと、組織ロールを通じてプロジェクトに暗黙的にアクセスできるユーザーの両方を返します。デフォルト値は
false
です。
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/users' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"country": "string",
"createdAt": "2025-05-04T09:42:00Z",
"emailAddress": "hello@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2025-05-04T09:42:00Z",
"lastName": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "string",
"roles": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_MEMBER"
}
],
"teamIds": [
"32b6e34b3d91647abb20e7b8"
],
"username": "hello@example.com"
}
],
"totalCount": 42
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}