Navigation

dropRole

On this page

  • Definition
  • Required Access
  • Example
dropRole

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

The dropRole command uses the following syntax:

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

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

A comment can be any valid BSON type (string, integer, object, array, etc).

New in version 4.4.

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.runCommand(
{
dropRole: "readPrices",
writeConcern: { w: "majority" }
}
)
Give Feedback

On this page

  • Definition
  • Required Access
  • Example