dropUser

On this page

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB server.

Definition

dropUser: Removes the user from the database on which you run the command.
Tip
In mongosh, this command can also be run through the db.dropUser() 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.

The command has the following syntax:

db.runCommand(
   {
     dropUser: "<user>",
     writeConcern: { <write concern> },
     comment: <any>
   }
)

The command has the following fields:

Field	Type	Description
`dropUser`	string	The name of the user to delete. You must issue the `dropUser` command while using the database where the user exists.
`writeConcern`	document	Optional. The level of write concern for the operation. See Write Concern Specification.
`comment`	any	Optional. A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations: mongod log messages, in the `attr.command.cursor.comment` field. Database profiler output, in the `command.comment` field. `currentOp` output, in the `command.comment` field. A comment can be any valid BSON type (string, integer, object, array, etc).

Before dropping a user who has the userAdminAnyDatabase role, ensure you have at least another user with user administration privileges.

You must have the dropUser action on a database to drop a user from that database.

The following sequence of operations in mongosh removes reportUser1 from the products database:

use products
db.runCommand( {
   dropUser: "reportUser1",
   writeConcern: { w: "majority", wtimeout: 5000 }
} )

Back

dropAllUsersFromDatabase

grantRolesToUser