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. The createUser command uses the following syntax:

Tip

Starting in version 4.2 of the mongo shell, you can use the passwordPrompt() method in conjunction with various user authentication/management methods/commands to prompt for the password instead of specifying the password directly in the method/command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.

{
  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>
}

createUser has the following fields:

Field字段	Type类型	Description描述
createUser	string	The name of the new user.
pwd	string	The user’s password. The pwd field is not required if you run createUser on the $external database to create users who have credentials stored externally to MongoDB. The value can be either: the user’s password in cleartext string, or passwordPrompt() to prompt for the user’s password. Tip Starting in version 4.2 of the mongo shell, you can use the passwordPrompt() method in conjunction with various user authentication/management methods/commands to prompt for the password instead of specifying the password directly in the method/command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.
customData	document	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	array	The roles granted to the user. Can specify an empty array [] to create users without roles.
digestPassword	boolean	Optional.可选。Indicates whether the server or the client digests the password. If true, the server receives undigested password from the client and digests the password. If false, the client digests the password and passes the digested password to the server. Not compatible with SCRAM-SHA-256 Changed in version 4.0.在版本4.0中更改。The default value is true. In earlier versions, the default value is false.
writeConcern	document	Optional.可选。The level of write concern for the creation operation. The writeConcern document takes the same fields as the getLastError command.
authenticationRestrictions	array	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. New in version 3.6.版本3.6中的新功能。
mechanisms	array	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. Valid values are: "SCRAM-SHA-1" Uses the SHA-1 hashing function. "SCRAM-SHA-256" Uses the SHA-256 hashing function. Requires featureCompatibilityVersion set to 4.0. Requires digestPassword to be true. The default for featureCompatibilityVersion is 4.0 is both SCRAM-SHA-1 and SCRAM-SHA-256. The default for featureCompatibilityVersion is 3.6 is SCRAM-SHA-1. New in version 4.0.版本4.0中的新功能。
digestPassword	boolean	Optional.可选。Indicates whether the server or the client digests the password. If true, the server receives undigested password from the client and digests the password. If false, the client digests the password and passes the digested password to the server. Not compatible with SCRAM-SHA-256 Changed in version 4.0:The default value is true. In earlier versions, the default value is false.
comment	any	Optional.可选。A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations: mongod log messages, in the attr.command.cursor.comment field. Database profiler output, in the command.comment field. currentOp output, in the command.comment field. A comment can be any valid BSON type (string, integer, object, array, etc). New in version 4.4.版本4.4中的新功能。

"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.
• To grant roles to a user, you must have the grantRole action on the role’s database.

The userAdmin and userAdminAnyDatabase built-in roles provide createUser and grantRole actions on their respective resources.

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:

 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 }
} )