Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API 资源
/
项目和用户
/
项目

获取一个项目中的所有用户

在此页面上

  • Resource
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/users

请求参数

请求路径参数

名称
类型
必要性
说明
PROJECT-ID
字符串
必需
项目的唯一标识符。

请求查询参数

名称
类型
必要性
说明
flattenTeams
布尔
Optional

指示返回的列表是否应包含属于在此项目中分配角色的团队的用户的标志。 您可能尚未在此项目中为各个用户分配角色。

  • 如果此标志设置为false ，则端点仅返回在项目中分配有角色的用户。

  • 如果此标志设置为true ，则端点会返回分配有项目角色的用户以及属于分配有项目角色的团队成员的用户。

includeOrgUsers
布尔
Optional

指示返回的列表是否应包含可通过Organization Owner或Organization Read Only角色隐式访问项目的用户的标志。 您可能尚未在此项目中为各个用户分配角色。

  • 如果此标志设置为false ，则端点仅返回在项目中分配有角色的用户。

  • 如果此标志设置为true ，则端点会返回在项目中分配有角色的用户以及通过其组织角色对项目具有隐式访问权限的用户。

默认值为 false。

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应文档

响应 JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明
results
阵列
数组为results嵌入式文档部分中详细介绍的每一项包含一个对象。
links
阵列
totalCount
数字
结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。

results 嵌入式文档

每个结果代表一个用户。

名称
类型
说明
邮箱
字符串
分配给返回的 MongoDB Atlas 用户的电子邮件地址。
名
字符串
分配给返回的 MongoDB Atlas 用户的名字。
id
字符串
分配给返回的 MongoDB Atlas Atlas user 的唯一标识符。
姓
字符串
分配给返回的 MongoDB Atlas Atlas user 的姓氏。
链接
对象数组

指向子资源和/或相关资源的一个或多个链接。 响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

角色
对象数组
分配给返回的 MongoDB Atlas Atlas user的角色。
roles.groupId
字符串
为返回的 MongoDB Atlas user分配了role.roleName中提供的角色的项目的唯一标识符。
roles.orgId
字符串
返回的 MongoDB Atlas 用户被分配到role.roleName中提供的角色的组织的唯一标识符。
roles.roleName
字符串
对于role.groupId中提供的群组或role.orgId中提供的组织，分配给返回的 MongoDB Atlas 用户的角色的显示名称。
用户名
字符串
为返回的 MongoDB Atlas 用户指定的 MongoDB Atlas 用户名。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&includeOrgUsers=true"

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/ users?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "emailAddress" : "joe.bloggs@example.com",
    "firstName" : "Joe",
    "id" : "{USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{OTHER-PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }
    ...
    ],
    "username" : "joe.bloggs"
  }, {
    "emailAddress" : "jim.bloggs@example.com",
    "firstName" : "Jim",
    "id" : "{OTHER-USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "roleName" : "GLOBAL_READ_ONLY"
    }, {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "orgId" : "{ORGANIZATION-ID}",
      "roleName" : "ORG_READ_ONLY"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}

后退

更新单个用户的项目角色

来年

将现有用户添加到一个项目