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

创建一个用户

在此页面上

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

注意

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

创建一个新用户。 默认情况下，有效负载中的任何非全局组织和项目角色都会先向用户发送加入组织或项目的邀请。

Resource

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

POST /users

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

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

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

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

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

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

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

请求正文参数

所有字段均为必填字段。

名称
类型
说明
用户名
字符串
Cloud Manager 用户的用户名。必须是有效的电子邮件地址。
密码
字符串

Cloud Manager 用户的密码。

从服务器返回的实体中不包含此字段。只能在创建新用户时在实体正文中发送。

邮箱
字符串
Cloud Manager 用户的电子邮件地址。
mobileNumber
字符串
Cloud Manager 用户的移动电话号码。
名
字符串
Cloud Manager用户的名字。
姓
字符串
Cloud Manager 用户的姓氏。
国家
字符串
Cloud Manager 用户所在的主要国家/地区。必须匹配两个字母的 ISO3661 -1 国家/地区代码。
角色
对象数组
Cloud Manager 用户的角色分配。
roles.orgId
字符串
Cloud Manager 用户在其中具有指定角色的组织的唯一标识符。
roles.groupId
字符串
Cloud Manager 用户在其中具有指定角色的群组的唯一标识符。
roles.roleName
字符串

角色的名称。接受的值为：

值
说明
ORG_MEMBER
Organization 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

响应

JSON文档包含以下每个元素：

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

角色的名称。接受的值为：

注意

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

值
说明
ORG_MEMBER
ORG_READ_ONLY
ORG_BILLING_ADMIN
Organization Billing Admin
ORG_GROUP_CREATOR
ORG_OWNER
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
username
字符串
Cloud Manager 用户的用户名。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \
6     --data '
7       {
8         "username": "jane.doe@mongodb.com",
9         "emailAddress": "jane.doe@mongodb.com",
10         "firstName": "Jane",
11         "lastName": "Doe",
12         "password": "M0ng0D8!:)",
13         "country" : "US",
14         "roles": [{
15           "groupId": "533daa30879bb2da07807696",
16           "roleName": "GROUP_USER_ADMIN"
17         },{
18           "orgId" : "55555bbe3bd5253aea2d9b16",
19           "roleName" : "ORG_MEMBER"
20         }]
21       }'

响应示例

响应标头

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 201 Created
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.doe@mongodb.com",
  "emailAddress" : "jane.doe@mongodb.com",
  "firstName" : "Jane",
  "lastName" : "Doe",
  "roles" : [],
  "links" : []
}

后退

通过名称获取用户