On this page

• Definition
• Behavior
• Required Access
• Examples

Definition

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.

The db.createUser() method has the following syntax:

Field	Type	Description
user	document	The document with authentication and access information about the user to create.
writeConcern	document	Optional. The level of write concern for the creation operation. The writeConcern document takes the same fields as the getLastError command.

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

copy

{
  user: "<name>",
  pwd: "<cleartext password>",
  customData: { <any information> },
  roles: [
    { role: "<role>", db: "<database>" } | "<role>",
    ...
  ],
  authenticationRestrictions: [
     {
       clientSource: ["<IP>" | "<CIDR range>", ...],
       serverAddress: ["<IP>" | "<CIDR range>", ...]
     },
     ...
  ]
}

The user document has the following fields:

Field	Type	Description
user	string	The name of the new user.
pwd	string	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.
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.
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.

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

Examples

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

use products
db.createUser( { user: "accountAdmin01",
                 pwd: "changeMe",
                 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: "password",
     roles: [ "readWrite", "dbAdmin" ]
   }
)

use admin
db.createUser(
   {
     user: "reportsUser",
     pwd: "password",
     roles: [ ]
   }
)

use admin
db.createUser(
   {
     user: "appAdmin",
     pwd: "password",
     roles:
       [
         { role: "readWrite", db: "config" },
         "clusterAdmin"
       ]
   }
)

use admin
db.createUser(
   {
     user: "restricted",
     pwd: "password",
     roles: [ ],
     authenticationRestrictions: [ {
        clientSource: ["192.0.2.0"],
        serverAddress: ["198.51.100.0"]
     } ]
   }
)