Docs Menu

Docs HomeMongoDB Manual

db.dropRole()

On this page

  • Definition
  • Behavior
  • Required Access
  • Example
db.dropRole( rolename, writeConcern )

Deletes a user-defined role from the database on which you run the method.

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the dropRole command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

The db.dropRole() method takes the following arguments:

Parameter
Type
Description
rolename
string
The name of the user-defined role to remove from the database.
writeConcern
document

Optional. The level of write concern for the operation. See Write Concern Specification.

When a role is dropped on a mongod, previously authenticated users remain logged in to the database but immediately lose the role's privileges.

When a role is dropped on a mongos, previously authenticated users remain logged in to the database but lose the role's privileges when the cache refreshes. The cache refreshes automatically after the time specified with the userCacheInvalidationIntervalSecs parameter or manually when you run the invalidateUserCache command.

If run on a replica set, db.dropRole() is executed using "majority" write concern by default.

You must have the dropRole action on a database to drop a role from that database.

The following operations remove the readPrices role from the products database:

use products
db.dropRole( "readPrices", { w: "majority" } )
←  db.createRole()db.dropAllRoles() →