返回一个项目中的所有 MongoDB Cloud 用户
已弃用
返回与指定项目关联的待处理和活跃的 MongoDB Cloud 用户的详细信息。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目只读”角色。
注意:此资源不能用于查看通过已弃用的“邀请一位 MongoDB Cloud 用户加入一个项目终结点”邀请的用户的详细信息。
注意:要同时返回待处理用户和活动用户,请使用 v2-{2025-02-19} 或更高版本。如果使用已弃用的版本,则仅返回活跃用户。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式:
^([a-f0-9]{24})$
。
查询参数
-
指示应用程序是否将响应包装在
envelope
JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false
。 -
标志,用于指示响应是否返回响应中的列项总数 (totalCount)。
默认值为
true
。 -
响应每页返回的列项数。
最小值为
1
,最大值为500
。默认值为100
。 -
显示响应返回的当前总对象集的页面编号。
最小值为
1
。默认值为1
。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false
。Prettyprint -
指示返回列表是否应包括属于在此项目中具有角色的团队的用户的标志。您可能尚未在此项目中为各个用户分配角色。如果为
"flattenTeams" : false
,则此资源仅返回在项目中具有角色的用户。如果为"flattenTeams" : true
,则此资源会同时返回在项目中具有角色的用户以及属于在项目中具有角色的团队的用户。默认值为
false
。 -
指示返回的列表是否应包含对项目具有隐式访问权限的用户、组织所有者或组织只读角色的标志。您可能尚未在此项目中为单个用户分配角色。如果为
"includeOrgUsers": false
,则此资源仅返回在项目中具有角色的用户。如果为"includeOrgUsers": true
,则此资源将返回在项目中具有角色的用户以及通过其组织角色对项目具有隐式访问权限的用户。默认值为
false
。 -
指示是否按用户的组织成员资格状态过滤返回列表的标志。如果排除此参数,此资源将返回待处理和活跃用户。已弃用版本不予支持。
-
用于过滤用户的电子邮件地址。已弃用版本不予支持。
atlas api mongoDbCloudUsers listGroupUsers --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListGroupUsersApiParams{}
sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
ListGroupUsersWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true"
{
"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"
}