Docs Menu

Docs HomeDevelop ApplicationsMongoDB Manual

db.revokeRolesFromRole()

On this page

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

Removes the specified inherited roles from a role.

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 revokeRolesFromRole 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.revokeRolesFromRole() method uses the following syntax:

db.revokeRolesFromRole( "<rolename>", [ <roles> ], { <writeConcern> } )

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

Parameter
Type
Description
rolename
string
The name of the role from which to revoke roles.
roles
array
The inherited roles to remove.
writeConcern
document

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

In the roles field, you can specify both built-in roles and user-defined roles.

To specify a role that exists in the same database where db.revokeRolesFromRole() runs, you can either specify the role with the name of the role:

"readWrite"

Or you can specify the role with a document, as in:

{ role: "<role>", db: "<database>" }

To specify a role that exists in a different database, specify the role with a document.

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

You must have the revokeRole action on a database to revoke a role on that database.

The purchaseAgents role in the emea database inherits privileges from several other roles, as listed in the roles array:

{
"_id" : "emea.purchaseAgents",
"role" : "purchaseAgents",
"db" : "emea",
"privileges" : [],
"roles" : [
{
"role" : "readOrdersCollection",
"db" : "emea"
},
{
"role" : "readAccountsCollection",
"db" : "emea"
},
{
"role" : "writeOrdersCollection",
"db" : "emea"
}
]
}

The following db.revokeRolesFromRole() operation on the emea database removes two roles from the purchaseAgents role:

use emea
db.revokeRolesFromRole( "purchaseAgents",
[
"writeOrdersCollection",
"readOrdersCollection"
],
{ w: "majority" , wtimeout: 5000 }
)

The purchaseAgents role now contains just one role:

{
"_id" : "emea.purchaseAgents",
"role" : "purchaseAgents",
"db" : "emea",
"privileges" : [],
"roles" : [
{
"role" : "readAccountsCollection",
"db" : "emea"
}
]
}
←  db.grantRolesToRole()db.updateRole() →