- Reference >
- mongo Shell Methods >
- Role Management Methods >
- db.getRole()
db.getRole()¶
On this page
Definition¶
- db.getRole(rolename, args)¶
Returns the roles from which this role inherits privileges. Optionally, the method can also return all the role’s privileges.
Run db.getRole() from the database that contains the role. The command can retrieve information for both user-defined roles and built-in roles.
The db.getRole() method accepts the following parameters:
Parameter Type Description rolename string The name of the role. args document Optional. A document specifying additional arguments. The args document supports the following fields:
Field Type Description showBuiltinRoles boolean Optional. When the rolesInfo field is set to 1, set showBuiltinRoles to true to include built-in roles in the output. By default this field is set to false, and the output for rolesInfo: 1 displays only user-defined roles. showPrivileges boolean Optional. Set the field to true to show role privileges, including both privileges inherited from other roles and privileges defined directly. By default, the command returns only the roles from which this role inherits privileges and does not return specific privileges. db.getRole() wraps the rolesInfo command.
Required Access¶
To view a role’s information, you must be either explicitly granted the role or must have the viewRole action on the role’s database.
Examples¶
The following operation returns role inheritance information for the role associate defined on the products database:
use products
db.getRole( "associate" )
The following operation returns role inheritance information and privileges for the role associate defined on the products database:
use products
db.getRole( "associate", { showPrivileges: true } )