createUser

Definition定义

createUser

Creates a new user on the database where you run the command. 在运行命令的数据库上创建新用户。The createUser command returns a duplicate user error if the user exists.如果用户存在，createUser命令将返回一个重复的用户错误。

Tip

In mongosh, this command can also be run through the db.createUser() helper method.在mongosh中，这个命令也可以通过db.createUser()助手方法运行。

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. 助手方法对mongosh用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。 In cases where the convenience is not needed or the additional return fields are required, use the database command.如果不需要方便，或者需要额外的返回字段，请使用数据库命令。

Syntax语法

The command has the following syntax:该命令具有以下语法：

db.runCommand(
   {
     createUser: "<name>",
     pwd: passwordPrompt(),      // Or  "<cleartext password>"
     customData: { <any information> },
     roles: [
       { role: "<role>", db: "<database>" } | "<role>",
       ...
     ],
     writeConcern: { <write concern> },
     authenticationRestrictions: [
        { clientSource: [ "<IP|CIDR range>", ... ], serverAddress: [ "<IP|CIDR range>", ... ] },
        ...
     ],
     mechanisms: [ "<scram-mechanism>", ... ],  //Available starting in MongoDB 4.0
     digestPassword: <boolean>,
     comment: <any>
   }
)

"readWrite"

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

Behavior行为

Required Access所需访问权限

• To create a new user in a database, you must have the createUser action on that database resource.要在数据库中创建新用户，必须对该数据库资源执行createUser操作。
• To grant roles to a user, you must have the grantRole action on the role's database.要向用户授予角色，必须对角色的数据库执行grantRole操作。

The userAdmin and userAdminAnyDatabase built-in roles provide createUser and grantRole actions on their respective resources.userAdmin和userAdminAnyDatabase内置角色在各自的资源上提供createUser和grantRole操作。

Example实例

The following createUser command creates a user accountAdmin01 on the products database. The command gives accountAdmin01 the clusterAdmin and readAnyDatabase roles on the admin database and the readWrite role on the products database:下面的createUser命令在products数据库上创建一个用户accountAdmin01。该命令赋予accountAdmin01在admin数据库上的clusterAdmin和readAnyDatabase角色，以及products数据库上的readWrite角色：

 db.getSiblingDB("products").runCommand( {
       createUser: "accountAdmin01",
       pwd: passwordPrompt(),
       customData: { employeeId: 12345 },
       roles: [
                { role: "clusterAdmin", db: "admin" },
                { role: "readAnyDatabase", db: "admin" },
                "readWrite"
              ],
       writeConcern: { w: "majority" , wtimeout: 5000 }
} )