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

grantRolesToRole

On this page

  • Definition
  • Compatibility
  • Behavior
  • Required Access
  • Example

Definition

grantRolesToRole

Grants roles to a user-defined role.

Tip

In mongosh, this command can also be run through the db.grantRolesToRole() 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 grantRolesToRole command affects roles on the database where the command runs.

The command has the following syntax:

db.runCommand(
   {
     grantRolesToRole: "<role>",
     roles: [
                { role: "<role>", db: "<database>" },
                ...
            ],
     writeConcern: { <write concern> },
     comment: <any>
   }
)

The command has the following fields:

Field
Type
Description
grantRolesToRole
string
The name of a role to add subsidiary roles.
roles
array
An array of roles from which to inherit.
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).

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

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.

Behavior

A role can inherit privileges from other roles in its database. A role created on the admin database can inherit privileges from roles in any database.

Required Access

You must have the grantRole action on a database to grant a role on that database.

Example

The following grantRolesToRole command updates the productsReaderWriter role in the products database to inherit the privileges of the productsReader role in the products database:

use products
db.runCommand(
   { grantRolesToRole: "productsReaderWriter",
     roles: [
              "productsReader"
     ],
     writeConcern: { w: "majority" , wtimeout: 5000 }
   }
)

Back

grantPrivilegesToRole

Next

invalidateUserCache