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

通过 ID 获取用户

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

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

您可以随时找回自己的用户帐户。否则，您必须至少在一个您和要检索的用户共有的项目中拥有 Project User Admin角色。

您无法使用此端点返回 API 密钥的信息。请求获取一个 API 密钥端点以获取此信息。

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

Resource

GET /users/{USER-ID}

请求路径参数

Parameter
类型
说明
用户 ID
字符串
（必需。）要检索的用户的唯一标识符。要检索用户的 USER-ID，请参阅获取一个项目中的所有用户。

请求查询参数

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

名称
类型
必要性
说明
默认
pretty
布尔
Optional
false
envelope
布尔
Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称
说明
status
HTTP 响应代码
content
预期响应正文
false

请求正文参数

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

响应

该HTTP 文档包含以下每个元素：

名称
类型
说明
邮箱
字符串
Cloud Manager 用户的电子邮件地址。
名
字符串
Cloud Manager用户的名字。
id
字符串
Cloud Manager 用户的唯一标识符。
姓
字符串
Cloud Manager 用户的姓氏。
链接
对象数组
相关子资源链接。 响应中的所有links数组至少包含一个名为 self 的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
mobileNumber
字符串
Cloud Manager 用户的手机号码。
角色
对象数组
角色分配。
roles.groupId
字符串
用户具有指定角色的项目的唯一标识符。
roles.orgId
字符串
用户在其中具有指定角色的组织的唯一标识符。
roles.roleName
字符串

角色名称。 users资源返回用户在 Cloud Manager 和 MongoDB Atlas 中拥有的所有角色。

以下值是有效的：

值
说明
ORG_MEMBER
ORG_READ_ONLY
ORG_BILLING_ADMIN
ORG_GROUP_CREATOR
ORG_OWNER
GROUP_ATLAS_ADMIN
Project Admin (Atlas)
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN
GROUP_BILLING_ADMIN
项目计费管理员
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
用户名
字符串
Cloud Manager 用户的用户名。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/users/533dc19ce4b00835ff81e2eb"

响应示例

响应标头

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}

响应体

{
  "id" : "533dc19ce4b00835ff81e2eb",
  "username" : "jane",
  "emailAddress" : "jane@qa.example.com",
  "firstName" : "Jane",
  "lastName" : "D'oh",
  "roles" : [ {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  } ],
  "links" : [],
  "username": "jane"
}

后退

用户(User)