获取所有组织用户
2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
- 用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。
- 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
语法
GET /orgs/{ORG-ID}/users
请求路径参数
Parameter | 必需/可选 | 说明 |
|---|---|---|
ORG-ID | 必需。 | 要检索其用户信息的组织的唯一标识符。 |
请求查询参数
字段 | 必需/可选 | 说明 |
|---|---|---|
pageNum | 可选。 | 要返回的页面。 默认值为 |
itemsPerPage | 可选。 | 每页要返回的项目数，最多 500 个。 默认值为 |
envelope | 可选。 | 布尔值，指定是否将响应包装在信封中。 默认值为 |
pretty | Optional | 一个布尔值，用于指定是否返回“美观打印的” JSON document 。 默认值为 |
响应元素
如果将查询元素envelope设置为true ，则响应将由content对象包装。
HTTP 响应返回一个 JSON document，其中包含以下对象：
results
一组文档，每个文档代表一个组织用户。
名称 | 说明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
country | 用户居住的国家/地区。 | ||||||||||||||
emailAddress | 用户的电子邮件地址。 | ||||||||||||||
firstName | 用户的名字。 | ||||||||||||||
lastName | 用户所属的 Cloud Manager 项目的 ID。 | ||||||||||||||
id | 用户的 ID。 | ||||||||||||||
links | 指向子资源和/或相关资源的一个或多个链接。 | ||||||||||||||
mobileNumber | 用户的手机号码。 | ||||||||||||||
username | 用于向 MongoDB 进行身份验证的用户名。 | ||||||||||||||
roles | 用户在组织中以及用户所属的每个项目中的角色的数组。 | ||||||||||||||
roles.{ENTITY-ID} | {ENTITY-ID}代表此角色适用的组织或项目。 可能的值为： orgId或groupId 。 | ||||||||||||||
roles.roleName | 角色的名称。
| ||||||||||||||
teamIds | 组织的团队 ID 数组。 |
links
totalCount
结果集中的项目总数。 如果对整个结果集进行分页，则该值可能大于results数组中的对象数。
请求示例
请求
curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"
响应
{ "links" : [ ... ], "results" : [ { "country": "US", "emailAddress": "someone@example.com", "firstName": "John", "id": "59db8d1d87d9d6420df0613a", "lastName": "Smith", "links": [ ... ], "mobileNumber": "123-456-7890", "roles": [{ "groupId": "59ea02e087d9d636b587a967", "roleName": "GROUP_OWNER" }, { "groupId": "59db8d1d87d9d6420df70902", "roleName": "GROUP_OWNER" }, { "orgId": "59db8d1d87d9d6420df0613f", "roleName": "ORG_OWNER" }], "teamIds" : [ "5aeeed020bd6ef9d00033291", "5ac2aeadcabceef96172be31" ], "username": "someone@example.com" }, ... ], "totalCount" : 2 }