创建第一个用户

在此页面上

Resource

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

创建第一个MongoDB Ops Manager用户。您可以在没有 API密钥的情况下调用此端点。

重要

异常

如果MongoDB Ops Manager使用 LDAP进行身份验证，则无法使用此端点。
仅当MongoDB Ops Manager在 Invitation Only Mode 中运行时，此端点才能创建第一个用户。

MongoDB Ops Manager向通过此端点创建的第一个MongoDB Ops Manager编程API密钥授予 GLOBAL_OWNER角色。返回的JSON文档包含第一个编程API密钥，您可以使用该密钥进行进一步的API调用。

此端点不会创建项目或组织。使用它创建的新编程API密钥，您可以调用“创建项目”端点。该端点可以在一次API调用中创建项目和组织。创建项目之前，您无法登录MongoDB Ops Manager 。

您可以使用此端点创建其他用户，但需要注意以下事项：

MongoDB Ops Manager不会为这些后续用户授予GLOBAL_OWNER角色，除非您将角色添加到API请求中。
MongoDB Ops Manager不会为后续用户创建编程API密钥。

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

Resource

POST /unauth/users

请求路径参数

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

请求查询参数

名称	类型	说明
accessList	字符串	IP要添加到第一个MongoDB Ops Manager 用户的访问列表的地址。您可以添加多个`accessList`参数和值。

请求正文参数

名称

类型

必要性

说明

username

字符串

必需

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

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

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

username通常是电子邮件解决。如果将此值设立为电子邮件解决，则无需显式设立emailAddress值。

password

字符串

必需

第一个MongoDB Ops Manager用户的密码。此字段不包含在HTTP响应正文中。 MongoDB Ops ManagerHTTP仅当创建第一个MongoDB Ops Manager 用户时，MongoDB Ops 才会在请求中发送此信息。

emailAddress

字符串

Optional

第一个MongoDB Ops Manager用户的电子邮件地址。

firstName

字符串

必需

第一个MongoDB Ops Manager用户的名字。

lastName

字符串

必需

第一个MongoDB Ops Manager用户的姓氏。

响应

名称	类型	说明
`programmaticApiKey`	对象	在API 中创建的第一个编程MongoDB Ops Manager 密钥的详细信息。
`programmaticApiKey` `.desc`	字符串	第一个编程API密钥的描述。
`programmaticApiKey` `.id`	字符串	第一个编程API密钥的唯一标识符。
`programmaticApiKey` `.links`	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 Web 链接规范中解释了 URL 之间的关系。
`programmaticApiKey` `.privateKey`	字符串	三十一个字母数字字符和破折号，作为第一个编程API密钥的密码。
`programmaticApiKey` `.publicKey`	字符串	六个字母数字字符，用作第一个编程API密钥的用户名。
`programmaticApiKey` `.roles`	对象数组	分配给第一个编程 API 密钥的角色。
`programmaticApiKey` `.roles.roleName`	字符串	已分配角色的名称。 MongoDB Ops Manager授予第一个编程API密钥`Global Owner`角色(`GLOBAL_OWNER`)。
`user`	对象	第一个MongoDB Ops Manager用户的详细信息。
`user` `.emailAddress`	字符串	第一个MongoDB Ops Manager用户的电子邮件地址。
`user` `.firstName`	字符串	第一个MongoDB Ops Manager用户的名字。
`user` `.id`	字符串	第一个MongoDB Ops Manager用户的唯一标识符。
`user` `.lastName`	字符串	第一个MongoDB Ops Manager用户的姓氏。
`user` `.links`	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`user` `.mobileNumber`	字符串	第一个MongoDB Ops Manager用户的手机号码。
`user` `.roles`	对象数组	分配给第一个MongoDB Ops Manager 用户的角色。
`user` `.roles.roleName`	字符串	已分配角色的名称。 MongoDB Ops Manager会向第一个MongoDB Ops Manager用户授予`Global Owner`角色(`GLOBAL_OWNER`)。
`user` `.teamIds`	字符串数组	第一个MongoDB Ops Manager用户所属团队的唯一标识符列表。
`user` `.username`	字符串	第一个MongoDB Ops Manager用户的用户名。

请求示例

curl --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/unauth/users?pretty=true&accessList=1.2.3.4&accessList=2.3.4.5" \
     --data '
       {
         "username": "jane.doe@example.com",
         "password": "Passw0rd.",
         "firstName": "Jane",
         "lastName": "Doe"
       }'

响应示例

响应标头

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}

响应体

{
  "programmaticApiKey": {
    "desc": "Automatically generated Global API key",
    "id": "{API-KEY}",
    "links": [{
      "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY}",
      "rel": "self"
    }],
    "privateKey": "private key string",
    "publicKey": "public key string",
    "roles": [{
      "roleName": "GLOBAL_OWNER"
    }]
  },
  "user": {
    "emailAddress": "jane.doe@example.com",
    "firstName": "Jane",
    "id": "{USER-ID}",
    "lastName": "Doe",
    "links": [
      {
       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}",
       "rel" : "self"
      }
    ],
    "roles": [
      {
        "roleName": "GLOBAL_OWNER"
      }
    ],
    "username": "jane.doe@example.com"
  }
}

后退

更新单个用户的角色

来年

删除一个用户