创建一个用户

在此页面上

Resource

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

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

注意

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

创建一个新用户。默认，有效负载中的任何非全局组织和项目角色都会先向用户发送组织或项目邀请。仅当设立 mms.user.bypassInviteForExistingUsers设置为true时，才能将用户直接添加到组织或项目中。

Resource

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /users

请求路径参数

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

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

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

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

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

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

请求正文参数

所有字段均为必填字段。

名称

类型

说明

用户名

字符串

Ops Manager 用户的用户名。根据mms.email.validation属性的值进行验证：

值	说明
`false`	（默认）用户名不必为电子邮件地址。
`loose`	用户名必须包含一个 `@` 符号，且后跟一个句点。
`strict`	用户名必须遵循严格的电子邮件地址验证正则表达式。

请参阅 mms.email.validation 了解详细信息。

密码

字符串

Ops Manager 用户的密码。

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

邮箱

字符串

Ops Manager 用户的电子邮件地址。

mobileNumber

字符串

Ops Manager 用户的移动电话号码。

名

字符串

Ops Manager 用户的名字。

姓

字符串

Ops Manager 用户的姓氏。

角色

对象数组

Ops Manager 用户的角色分配。

roles.orgId

字符串

Ops Manager 用户在其中具有指定角色的组织的唯一标识符。

roles.groupId

字符串

Ops Manager 用户在其中具有指定角色的群组的唯一标识符。

对于“全局”角色（名称以GLOBAL_开头的角色），没有groupId ，因为这些角色未绑定到群组。

roles.roleName

字符串

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

值	说明
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

响应

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

Name

类型

说明

emailAddress

字符串

Ops Manager 用户的电子邮件地址。

firstName

字符串

Ops Manager 用户的名字。

id

字符串

Ops Manager 用户的唯一标识符。

lastName

字符串

Ops Manager 用户的姓氏。

links

对象数组

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

mobileNumber

字符串

Ops Manager 用户的手机号码。

roles

空数组

分配给 Ops Manager 用户的角色。

roles

.groupId

字符串

用户具有指定角色的项目的唯一标识符。

以GLOBAL_开头的角色不需要groupId 。这些角色不与项目绑定。

roles

.orgId

字符串

用户在其中具有指定角色的组织的唯一标识符。

roles

.roleName

字符串

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

值	说明
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

username

字符串

Ops Manager 用户的用户名。

请求示例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/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          "roles": [{
14            "groupId": "533daa30879bb2da07807696",
15            "roleName": "GROUP_USER_ADMIN"
16          },{
17            "orgId" : "55555bbe3bd5253aea2d9b16",
18            "roleName" : "ORG_MEMBER"
19          }]
20        }'

响应示例

响应标头

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" : []
}

后退

按名称获取

来年

更新角色

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/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	"roles": [{
14	"groupId": "533daa30879bb2da07807696",
15	"roleName": "GROUP_USER_ADMIN"
16	},{
17	"orgId" : "55555bbe3bd5253aea2d9b16",
18	"roleName" : "ORG_MEMBER"
19	}]
20	}'