Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
Database Commands
/
Role Management

grantPrivilegesToRole

On this page

  • Definition
  • Compatibility
  • Command Fields
  • Behavior
  • Required Access
  • Example

Definition

grantPrivilegesToRole

Assigns additional privileges to a user-defined role defined on the database on which the command is run.

Tip

In mongosh, this command can also be run through the db.grantPrivilegesToRole() helper method.

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

db.runCommand(
   {
     grantPrivilegesToRole: "<role>",
     privileges: [
       {
         resource: { <resource> }, actions: [ "<action>", ... ]
       },
       ...
     ],
     writeConcern: { <write concern> },
     comment: <any>
   }
)

Compatibility

This command is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Important

This command is not supported in M0, M2, and M5 clusters. For more information, see Unsupported Commands.

Command Fields

The command has the following fields:

Field
Type
Description
grantPrivilegesToRole
string
The name of the user-defined role to grant privileges to.
privileges
array
The privileges to add to the role. For the format of a privilege, see privileges.
writeConcern
document

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

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

Behavior

A role's privileges apply to the database where the role is created. A role created on the admin database can include privileges that apply to all databases or to the cluster.

Required Access

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.

Example

The following grantPrivilegesToRole command grants two additional privileges to the service role that exists in the products database:

use products
db.runCommand(
   {
     grantPrivilegesToRole: "service",
     privileges: [
         {
           resource: { db: "products", collection: "" }, actions: [ "find" ]
         },
         {
           resource: { db: "products", collection: "system.js" }, actions: [ "find" ]
         }
     ],
     writeConcern: { w: "majority" , wtimeout: 5000 }
   }
)

The first privilege in the privileges array allows the user to search on all non-system collections in the products database. The privilege does not allow queries on system collections, such as the system.js collection. To grant access to these system collections, explicitly provision access in the privileges array. See Resource Document on Self-Managed Deployments.

The second privilege explicitly allows the find action on system.js collections on all databases.

Back

dropAllRolesFromDatabase

Next

grantRolesToRole