db.changeUserPassword.txt

=======================
db.changeUserPassword()
=======================

.. default-domain:: mongodb

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

Definition
----------

.. method:: db.changeUserPassword(username, password)

   Updates a user's password. Run the method in the database where the
   user is defined, i.e. the database you :method:`created
   <db.createUser()>` the user.

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

   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - Parameter
        - Type
        - Description
      * - ``username``
        - string
        - The name of the user whose password you wish to change.
      * - ``password``
        - string
        - The user's password. 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

      * - ``writeConcern``
        - document
        - .. include:: /includes/fact-write-concern-spec-link.rst

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

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

.. include:: /includes/access-change-password.rst

Behavior
--------

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

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

Example
-------

The following operation changes the password of the user named
``accountUser`` in the ``products`` database to ``SOh3TbYhx8ypJPxmt1oOfL``:

.. tip::

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

.. code-block:: javascript

   use products
   db.changeUserPassword("accountUser", passwordPrompt())

When prompted in :binary:`~bin.mongosh` for the password, enter
the new password.

You can also pass the new password directly to
:method:`db.changeUserPassword()`:

.. code-block:: javascript

   use products
   db.changeUserPassword("accountUser", "SOh3TbYhx8ypJPxmt1oOfL")