获取分配给团队的所有用户

在此页面上

语法

请求路径参数
请求查询参数
请求正文参数
响应
响应文档
results 嵌入式文档
请求示例
响应示例
响应标头
响应体

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

注意

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

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

语法

GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users

请求路径参数

路径元素	必需/可选	说明
`ORG-ID`	必需	与团队关联的组织的唯一标识符。
`TEAM-ID`	必需	要检索其用户成员资格的团队的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印的标志格式。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点，`content` 对象是一个信封。Cloud Manager 将 `status` 字段添加到响应正文。	`false`
backupJobsEnabledOnly	布尔	Optional	指示是否从响应中排除未启用备份数据库的守护进程的标志。将其设置为`false`以包含将`backupJobsEnabled`标志设置为`false`的守护进程配置。	`true`

请求正文参数

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

响应

响应文档

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

名称	类型	说明
`results`	阵列	数组为`results`嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

result数组中的每个元素都是分配给团队的一个用户。

名称	类型	说明
`emailAddress`	字符串	与用户关联的电子邮件地址。
`firstName`	字符串	用户的名字。
`id`	字符串	团队的唯一标识符。
`lastName`	字符串	用户的姓氏。
`links`	对象数组	指向子资源和/或相关资源的一个或多个链接。 URL 之间的关系类型在 Web 链接规范中进行了解释。
`roles`	阵列	`roles`数组中的每个对象代表用户在关联的`orgId`或`groupId`中所具有的 MongoDB Atlas组织角色。
`roles.orgId`	字符串	为用户分配了`roles.roleName`组织角色的组织的 ID。
`roles.groupId`	字符串	为用户分配了项目角色的项目`roles.roleName` 的 ID。
`roles.roleName`	字符串	针对指定`roles.orgId`或`roles.groupId`分配给用户的组织角色。
`teamsIds`	阵列	用户所属的每个团队的string ID 数组。
`username`	字符串	与用户关联的用户名。

请求示例

curl --user "{username:apiKey}" --digest -i \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=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/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100",
     "rel": "self"
   }
 ],
 "results": [
   {
     "emailAddress": "CloudUser@example.com",
     "firstName": "Cloud",
     "id": "{USER-ID}",
     "lastName": "User",
     "links": [
       {
         "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
         "rel": "self"
       }
     ],
     "roles": [
       {
         "groupId": "{PROJECT-ID}",
         "roleName": "GROUP_OWNER"
       },
       {
         "orgId": "{ORG-ID}",
         "roleName": "ORG_OWNER"
       }
     ],
     "teamIds": [
       "{TEAM-ID}"
     ],
     "username": "CloudUser@example.com"
   }
 ],
 "totalCount": 1
}

后退

按名称获取一个团队

来年

创建团队

注意

语法