db.createUser()

定义

db.createUser(user, writeConcern)

Creates a new user for the database on which the method is run. db.createUser() returns a duplicate user error if the user already exists on the database.

重要

mongosh 方法

本页面提供 mongosh 方法的相关信息。这不是数据库命令或特定语言驱动程序（例如 Node.js）的相关文档。

有关数据库命令，请参阅 createUser 命令。

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

db.createUser() 方法使用的语法如下：

字段	类型	说明
user	文档	The document with authentication and access information about the user to create.
writeConcern	文档	可选。操作的写关注级别。请参阅写关注规范。

The user document defines the user and has the following form:

提示

您可以将 passwordPrompt() 方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。不过，您仍然可以像使用早期版本的 mongo shell 一样直接指定密码。

{
  user: "<name>",
  pwd: passwordPrompt(),      // Or  "<cleartext password>"
  customData: { <any information> },
  roles: [
    { role: "<role>", db: "<database>" } | "<role>",
    ...
  ],
  authenticationRestrictions: [
     {
       clientSource: ["<IP>" | "<CIDR range>", ...],
       serverAddress: ["<IP>" | "<CIDR range>", ...]
     },
     ...
  ],
  mechanisms: [ "<SCRAM-SHA-1|SCRAM-SHA-256>", ... ],
  passwordDigestor: "<server|client>"
}

user 文档包含以下字段：

字段	类型	说明
user	字符串	The name of the new user.
pwd	字符串	The user's password. The pwd field is not required if you run db.createUser() on the $external database to create users who have credentials stored externally to MongoDB. The value can be either: 以明文字符串表示的用户密码，或 passwordPrompt()提示输入用户密码。 您可以将 passwordPrompt() 方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。不过，您仍然可以像使用早期版本的 mongo shell 一样直接指定密码。
customData	文档	Optional. Any arbitrary information. This field can be used to store any data an admin wishes to associate with this particular user. For example, this could be the user's full name or employee id.
roles	阵列	The roles granted to the user. Can specify an empty array [] to create users without roles.
authenticationRestrictions	阵列	Optional. The authentication restrictions the server enforces on the created user. Specifies a list of IP addresses and CIDR ranges from which the user is allowed to connect to the server or from which the server can accept users.
mechanisms	阵列	Optional. Specify the specific SCRAM mechanism or mechanisms for creating SCRAM user credentials. If authenticationMechanisms is specified, you can only specify a subset of the authenticationMechanisms. 有效值为： "SCRAM-SHA-1" 使用 SHA-1 哈希函数。 "SCRAM-SHA-256" 使用 SHA-256 哈希函数。 要求 passwordDigestor 为server。 The default is both SCRAM-SHA-1 and SCRAM-SHA-256.
passwordDigestor	字符串	可选。指示对密码进行摘要处理的是服务器还是客户端。 可用值为： "server" （默认） 服务器会从客户端接收未加密的密码，然后对此密码进行加密。 "client"（与 SCRAM-SHA-256 不兼容） 客户端会对该密码进行哈希，并将哈希后的密码传递给服务器。

兼容性

此方法可用于以下环境中托管的部署：

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

"readWrite"

{ role: "<role>", db: "<database>" }

行为

必需的访问权限

• 要在数据库中创建新用户，您必须对该数据库资源执行 createUser操作。

• 要向用户授予角色，必须对该角色的数据库执行 grantRole 操作。

userAdmin 和 userAdminAnyDatabase 内置角色提供对资源的 createUser 和 grantRole 动作。

示例

The following db.createUser() operation creates the accountAdmin01 user on the products database.

use products
db.createUser( { user: "accountAdmin01",
                 pwd: passwordPrompt(),  // Or  "<cleartext password>"
                 customData: { employeeId: 12345 },
                 roles: [ { role: "clusterAdmin", db: "admin" },
                          { role: "readAnyDatabase", db: "admin" },
                          "readWrite"] },
               { w: "majority" , wtimeout: 5000 } )

The operation gives accountAdmin01 the following roles:

• the clusterAdmin and readAnyDatabase roles on the admin database

• the readWrite role on the products database

use products
db.createUser(
   {
     user: "accountUser",
     pwd: passwordPrompt(),  // Or  "<cleartext password>"
     roles: [ "readWrite", "dbAdmin" ]
   }
)

use admin
db.createUser(
   {
     user: "reportsUser",
     pwd: passwordPrompt(),  // Or  "<cleartext password>"
     roles: [ ]
   }
)

use admin
db.createUser(
   {
     user: "appAdmin",
     pwd: passwordPrompt(),   // Or  "<cleartext password>"
     roles:
       [
         { role: "readWrite", db: "config" },
         "clusterAdmin"
       ]
   }
)

use admin
db.createUser(
   {
     user: "restricted",
     pwd: passwordPrompt(),      // Or  "<cleartext password>"
     roles: [ { role: "readWrite", db: "reporting" } ],
     authenticationRestrictions: [ {
        clientSource: ["192.0.2.0"],
        serverAddress: ["198.51.100.0"]
     } ]
   }
)

use reporting
db.createUser(
   {
     user: "reportUser256",
     pwd: passwordPrompt(),   // Or  "<cleartext password>"
     roles: [ { role: "readWrite", db: "reporting" } ],
     mechanisms: [ "SCRAM-SHA-256" ]
   }
)