Docs Menu

Docs Home → Develop Applications → MongoDB Manual

db.grantRolesToRole()

On this page

  • Definition
  • Behavior
  • Required Access
  • Example

Definition

db.grantRolesToRole(rolename, roles, writeConcern)

Grants roles to a user-defined role.

The db.grantRolesToRole() method uses the following syntax:

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

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

Parameter
Type
Description
rolename
string
The name of the role to which to grant sub 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.

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

The db.grantRolesToRole() method wraps the grantRolesToRole command.

Behavior

Replica set

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

Scope

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 db.grantRolesToRole() operation updates the productsReaderWriter role in the products database to inherit the privileges of productsReader role:

use products
db.grantRolesToRole(
    "productsReaderWriter",
    [ "productsReader" ],
    { w: "majority" , wtimeout: 5000 }
)
←  db.revokePrivilegesFromRole()db.revokeRolesFromRole() →

On this page