createUser (original) (raw)

createUser

Creates a new user on the database where you run the command. ThecreateUser command returns a duplicate user error if the user exists.

Tip

In mongosh, this command can also be run through the db.createUser() helper method.

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

This command is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Important

This command is not supported in M0, M2, M5, M10+, and Flex clusters. For more information, see Unsupported Commands.

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

The command has the following syntax:

Tip

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

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>", ... ],

     digestPassword: <boolean>,

     comment: <any>

   }

)

createUser has the following fields:

In the roles field, you can specify bothbuilt-in roles and user-defined roles.

To specify a role that exists in the same database wherecreateUser runs, you can either specify the role with the name of the role:

Or you can specify the role with a document, as in:

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

To specify a role that exists in a different database, specify the role with a document.

The authenticationRestrictions document can contain only the following fields. The server throws an error if theauthenticationRestrictions document contains an unrecognized field:

Important

If a user inherits multiple roles with incompatible authentication restrictions, that user becomes unusable.

For example, if a user inherits one role in which theclientSource field is ["198.51.100.0"] and another role in which the clientSource field is ["203.0.113.0"] the server is unable to authenticate the user.

For more information on authentication in MongoDB, seeAuthentication on Self-Managed Deployments.

MongoDB automatically assigns a unique userId to the user upon creation.

Warning

By default, createUser sends all specified data to the MongoDB instance in cleartext, even if using passwordPrompt(). Use TLS transport encryption to protect communications between clients and the server, including the password sent by createUser. For instructions on enabling TLS transport encryption, seeConfigure mongod and mongos for TLS/SSL.

MongoDB does not store the password in cleartext. The password is only vulnerable in transit between the client and the server, and only if TLS transport encryption is not enabled.

Users created on the $external database should have credentials stored externally to MongoDB, as, for example, with MongoDB Enterprise installations that use Kerberos.

To use Client Sessions and Causal Consistency Guarantees with $external authentication users (Kerberos, LDAP, or X.509 users), usernames cannot be greater than 10k bytes.

You cannot create users on the local database.

Usernames must consist of at least one character and cannot be larger than 7MB.

• To create a new user in a database, you must have thecreateUser action on that database resource.
• To grant roles to a user, you must have the grantRole action on the role's database.

The userAdmin anduserAdminAnyDatabase built-in roles providecreateUser and grantRole actions on their respective resources.

The following createUser command creates a user accountAdmin01 on theproducts database. The command gives accountAdmin01 theclusterAdmin and readAnyDatabase roles on the admin database and the readWrite role on the products database:

Tip

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

 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 }

} )