名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否采用 pretty-print 格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

名称	类型	说明
id	字符串	现有用户的唯一标识符。
角色	对象数组	为该用户分配的角色。
roles.groupId	字符串	项目角色的唯一标识符。
roles.roleName	字符串	用户角色的显示名称。

响应

名称	类型	说明
邮箱	字符串	Ops Manager 用户的电子邮件地址。
名	字符串	为返回的 Ops Manager 用户显示的名字。
id	字符串	用户的唯一标识符。
链接	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
姓	字符串	为返回的 Ops Manager 用户显示的姓氏。
角色	对象数组	为该用户分配的角色。
roles.groupId	字符串	项目角色的唯一标识符。
roles.roleName	字符串	用户角色的显示名称。
用户名	字符串	Ops Manager 用户名。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true" \
 --data '
 [
   {
     "id": "{USER-ID}",
     "roles": [{
       "roleName": "GROUP_OWNER"
     }]
   }
 ]'

注意

即使添加单个用户，也必须发送实体数组。对于要添加的每个用户，请指定用户 ID 和用户应具有的角色。有关角色值，请参阅用户资源中roles.roleName字段的说明。

如果指定的用户已经是项目成员，则其现有角色将被指定的权限覆盖。

响应示例

响应标头

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" : "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "emailAddress" : "joe.bloggs@example.com",
    "firstName" : "Joe",
    "id" : "{USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{OTHER-PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }
    ...
    ],
    "username" : "joe.bloggs"
  }, {
    "emailAddress" : "jim.bloggs@example.com",
    "firstName" : "Jim",
    "id" : "{OTHER-USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "roleName" : "GLOBAL_READ_ONLY"
    }, {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}