revokePrivilegesFromRole
On this page
Definition
revokePrivilegesFromRole
Removes the specified privileges from the user-defined role on the database where the command is run. The
revokePrivilegesFromRole
command has the following syntax:Tip
In the
mongo
Shell, this command can also be run through thedb.revokePrivilegesFromRole()
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.{ revokePrivilegesFromRole: "<role>", privileges: [ { resource: { <resource> }, actions: [ "<action>", ... ] }, ... ], writeConcern: <write concern document>, comment: <any> } The
revokePrivilegesFromRole
command has the following fields:FieldTypeDescriptionrevokePrivilegesFromRole
stringThe user-defined role to revoke privileges from.privileges
arrayAn array of privileges to remove from the role. Seeprivileges
for more information on the format of the privileges.writeConcern
documentOptional. The level of write concern for the modification. ThewriteConcern
document takes the same fields as thegetLastError
command.comment
anyOptional. 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 thecommand.comment
field.
A comment can be any valid BSON type (string, integer, object, array, etc).
New in version 4.4.
Behavior
To revoke a privilege, the resource document pattern must match exactly the
resource
field of that privilege. The actions
field can be a
subset or match exactly.
For example, consider the role accountRole
in the products
database with the following privilege that specifies the products
database as the resource:
{ "resource" : { "db" : "products", "collection" : "" }, "actions" : [ "find", "update" ] }
You cannot revoke find
and/or update
from just one
collection in the products
database. The following operations
result in no change to the role:
use products db.runCommand( { revokePrivilegesFromRole: "accountRole", privileges: [ { resource : { db : "products", collection : "gadgets" }, actions : [ "find", "update" ] } ] } ) db.runCommand( { revokePrivilegesFromRole: "accountRole", privileges: [ { resource : { db : "products", collection : "gadgets" }, actions : [ "find" ] } ] } )
To revoke the "find"
and/or the "update"
action from the role
accountRole
, you must match the resource document exactly. For
example, the following operation revokes just the "find"
action
from the existing privilege.
use products db.runCommand( { revokePrivilegesFromRole: "accountRole", privileges: [ { resource : { db : "products", collection : "" }, actions : [ "find" ] } ] } )
Required Access
You must have the revokeRole
action on the database a privilege targets in order to
revoke that privilege. If the privilege targets multiple databases or the
cluster
resource, you must have the revokeRole
action
on the admin
database.
Example
The following operation removes multiple privileges from the
associates
role in the products
database:
use products db.runCommand( { revokePrivilegesFromRole: "associate", privileges: [ { resource: { db: "products", collection: "" }, actions: [ "createCollection", "createIndex", "find" ] }, { resource: { db: "products", collection: "orders" }, actions: [ "insert" ] } ], writeConcern: { w: "majority" } } )