Docs Menu
Docs Home
MongoDB Manual
/ / /


On this page

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

Grants additional privileges to a user-defined role.


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

"< rolename >",
{ resource: { <resource> }, actions: [ "<action>", ... ] },
{ < writeConcern > }

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

The name of the role to grant privileges to.
The privileges to add to the role. For the format of a privilege, see privileges.

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

The db.grantPrivilegesToRole() method can grant one or more privileges. Each <privilege> has the following syntax:

{ resource: { <resource> }, actions: [ "<action>", ... ] }

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

Except for roles created in the admin database, a role can only include privileges that apply to its database

A role created in the admin database can include privileges that apply to the admin database, other databases or to the cluster resource.

You must have the grantRole action on the database a privilege targets in order to grant the privilege. To grant a privilege on multiple databases or on the cluster resource, you must have the grantRole action on the admin database.

The following db.grantPrivilegesToRole() operation grants two additional privileges to the role inventoryCntrl01, which exists on the products database. The operation is run on that database:

use products
resource: { db: "products", collection: "" },
actions: [ "insert" ]
resource: { db: "products", collection: "system.js" },
actions: [ "find" ]
{ w: "majority" }

The first privilege permits users with this role to perform the insert action on all collections of the products database, except the system collections. To access a system collection, a privilege must explicitly specify the system collection in the resource document, as in the second privilege.

The second privilege permits users with this role to perform the find action on the product database's system collection named system.js.

← db.getRoles()