db.createUser.txt

===============
db.createUser()
===============

.. default-domain:: mongodb

.. facet::
   :name: programming_language
   :values: shell

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. method:: db.createUser(user, writeConcern)

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

   .. |dbcommand| replace:: :dbcommand:`createUser` command
   .. include:: /includes/fact-mongosh-shell-method-alt.rst

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


   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - Field
        - Type
        - Description
      * - ``user``
        - document
        - The document with authentication and access information about the
          user to create.
      * - ``writeConcern``
        - document
        - .. include:: /includes/fact-write-concern-spec-link.rst

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

   .. tip::

      .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

   .. code-block:: javascript

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

   The ``user`` document has the following fields:

   .. |local-cmd-name| replace:: :method:`db.createUser()`

   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - 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 |local-cmd-name| 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
          
          - :method:`passwordPrompt()` to prompt for the user's password. 
          
          .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst
          
          
   
      * - ``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.
          
          
   
      * - :ref:`authenticationRestrictions <db-createUser-authenticationRestrictions>`
   
        - array
   
        - .. _db-createUser-authenticationRestrictions:
        
          Optional. The authentication restrictions the server enforces on the created
          user. Specifies a list of IP addresses and
          :abbr:`CIDR (Classless Inter-Domain Routing)` ranges from which the
          user is allowed to connect to the server or from which the server can
          accept users.
          
          
   
      * - ``mechanisms``
   
        - array
   
        - Optional. Specify the specific SCRAM mechanism or mechanisms for creating
          SCRAM user credentials. If :parameter:`authenticationMechanisms` is
          specified, you can only specify a subset of the
          :parameter:`authenticationMechanisms`.
          
          Valid values are:
          
          - ``"SCRAM-SHA-1"``
          
            - Uses the ``SHA-1`` hashing function.
          
          - ``"SCRAM-SHA-256"``
          
            - Uses the ``SHA-256`` hashing function.
          
            - Requires passwordDigestor to be ``server``.
          
          The default is both ``SCRAM-SHA-1`` and ``SCRAM-SHA-256``.
          
   
      * - ``passwordDigestor``
   
        - string
   
        - Optional. Indicates whether the server or the client digests the password.
          
          Available values are:
          
          - ``"server"`` (Default)
                The server receives undigested password from the client and
                digests the password.
          
          - ``"client"`` (Not compatible with ``SCRAM-SHA-256``)
                The client digests the password and passes the digested
                password to the server.
          
Compatibility
-------------

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

.. include:: /includes/fact-environments-no-atlas-support.rst

.. include:: /includes/fact-environments-onprem-only.rst

Roles
~~~~~

.. include:: /includes/fact-roles-array-contents.rst

.. _method-createUser-authentication-restrictions:

Authentication Restrictions
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. include:: /includes/fact-auth-restrictions-array-contents.rst

The :method:`db.createUser()` method wraps the :dbcommand:`createUser`
command.

Behavior
--------

User ID
~~~~~~~

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

Replica set
~~~~~~~~~~~

.. |command| replace:: :method:`db.createUser()`

.. include:: /includes/fact-management-methods-write-concern.rst

Encryption
~~~~~~~~~~


.. include:: /includes/fact-cleartext-passwords-tls.rst

External Credentials
~~~~~~~~~~~~~~~~~~~~

Users created on the ``$external`` database should have credentials
stored externally to MongoDB, as, for example, with :doc:`MongoDB
Enterprise installations that use Kerberos
</tutorial/control-access-to-mongodb-with-kerberos-authentication>`.

.. include:: /includes/extracts/sessions-external-username-limit.rst

``local`` Database
~~~~~~~~~~~~~~~~~~

You cannot create users on the local database.

Required Access
---------------

.. include:: /includes/access-create-user.rst

Examples
--------

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

.. tip::

   .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

.. code-block:: javascript

   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

Create User with Roles
~~~~~~~~~~~~~~~~~~~~~~

The following operation creates ``accountUser`` in the ``products`` database
and gives the user the ``readWrite`` and ``dbAdmin`` roles.

.. tip::

   .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

.. code-block:: javascript

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

Create User without Roles
~~~~~~~~~~~~~~~~~~~~~~~~~

The following operation creates a user named ``reportsUser`` in the ``admin``
database but does not yet assign roles:

.. tip::

   .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

.. code-block:: javascript

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

Create Administrative User with Roles
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following operation creates a user named ``appAdmin`` in the
``admin`` database and gives the user ``readWrite`` access to the
``config`` database, which lets the user change certain settings for
sharded clusters, such as to the balancer setting.

.. tip::

   .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

.. code-block:: javascript

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

Create User with Authentication Restrictions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following operation creates a user named ``restricted`` in the
``admin`` database. This user may only authenticate if connecting from
IP address ``192.0.2.0`` to IP address ``198.51.100.0``.

.. tip::

   .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

.. code-block:: javascript

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

Create User with ``SCRAM-SHA-256`` Credentials Only
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::

   To use :ref:`SCRAM-SHA-256 <authentication-scram-sha-256>`, the
   ``featureCompatibilityVersion`` must be set to ``4.0``. For more
   information on featureCompatibilityVersion, see :ref:`view-fcv` and
   :dbcommand:`setFeatureCompatibilityVersion`.


The following operation creates a user with only ``SCRAM-SHA-256``
credentials.

.. tip::

   .. include:: /includes/extracts/4.2-changes-passwordPrompt.rst

.. code-block:: javascript

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


If the :parameter:`authenticationMechanisms` parameter is set, the
``mechanisms`` field can only include values specified in the
:parameter:`authenticationMechanisms` parameter.