- Reference >
- Database Commands >
- Role Management Commands >
- grantRolesToRole
grantRolesToRole¶
On this page
Definition¶
-
grantRolesToRole
¶ Grants roles to a user-defined role.
Tip
In the mongo Shell, this command can also be run through the
db.grantRolesToRole
helper method.Helper methods are convenient for mongo 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.grantRolesToRole
has the following syntax:The
grantRolesToRole
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 modification. The writeConcern
document takes the same fields as thegetLastError
command.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:Or you can specify the role with a document, as in:
To specify a role that exists in a different database, specify the role with a document.
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.
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: