dropUser¶

On this page

Definition
Required Access
Example

Definition¶

dropUser¶

Removes the user from the database on which you run the command. The dropUser command has the following syntax:

{
  dropUser: "<user>",
  writeConcern: { <write concern> },
  comment: <any>
}

The dropUser command document 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 removal operation. The writeConcern document takes the same fields as the getLastError command.

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

New in version 4.4.

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

Required Access¶

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

Example¶

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

copy

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

← dropAllUsersFromDatabase grantRolesToUser →