js-user-management.txt

=======================
User Management Methods
=======================

.. default-domain:: mongodb

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

.. include:: /includes/extracts/methods-toc-explanation.rst

.. list-table::
   :widths: 30,70
   :header-rows: 1

   * - Name

     - Description

   * - :method:`db.auth()`

     - Authenticates a user to a database.

   * - :method:`db.changeUserPassword()`

     - Changes an existing user's password.

   * - :method:`db.createUser()`

     - Creates a new user.
   

   * - :method:`db.dropUser()`

     - Removes a single user.
   

   * - :method:`db.dropAllUsers()`

     - Deletes all users associated with a database.
   

   * - :method:`db.getUser()`

     - Returns information about the specified user.
   

   * - :method:`db.getUsers()`

     - Returns information about all users associated with a database.
   

   * - :method:`db.grantRolesToUser()`

     - Grants a role and its privileges to a user.
   

   * - :method:`db.removeUser()`

     - Deprecated. Removes a user from a database.

   * - :method:`db.revokeRolesFromUser()`

     - Removes a role from a user.
   

   * - :method:`db.updateUser()`

     - Updates user data.
   

   * - :method:`passwordPrompt()`

     - Prompts for the password as an alternative to specifying passwords
       directly in various :binary:`~bin.mongosh` user
       authentication/management methods.
   


.. toctree::
   :titlesonly: 
   :hidden: 

   db.auth </reference/method/db.auth>
   db.changeUserPassword </reference/method/db.changeUserPassword>
   db.createUser </reference/method/db.createUser>
   db.dropUser </reference/method/db.dropUser>
   db.dropAllUsers </reference/method/db.dropAllUsers>
   db.getUser </reference/method/db.getUser>
   db.getUsers </reference/method/db.getUsers>
   db.grantRolesToUser </reference/method/db.grantRolesToUser>
   db.removeUser </reference/method/db.removeUser>
   db.revokeRolesFromUser </reference/method/db.revokeRolesFromUser>
   db.updateUser </reference/method/db.updateUser>
   passwordPrompt </reference/method/passwordPrompt>