dropRole¶

On this page

Definition
Behavior
Required Access
Example

Definition¶

dropRole¶

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

Tip

In the mongo Shell, this command can also be run through the db.dropRole helper method.

Helper methods are convenient for mongo 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 dropRole command uses the following syntax:

copy

{
  dropRole: "<role>",
  writeConcern: { <write concern> }
}

The dropRole command has the following fields:

Field	Type	Description
`dropRole`	string	The name of the user-defined role to remove from the database.
`writeConcern`	document	Optional. The level of write concern for the removal operation. The `writeConcern` document takes the same fields as the `getLastError` command.

Behavior¶

Authentication¶

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.

Required Access¶

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

Example¶

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

copy

use products
db.runCommand(
   {
     dropRole: "readPrices",
     writeConcern: { w: "majority" }
   }
)

← createRole dropAllRolesFromDatabase →