- Reference >
mongo
Shell Methods >- Role Management Methods >
- db.getRole()
db.getRole()¶
On this page
Definition¶
-
db.
getRole
(rolename, showPrivileges)¶ 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 takes the following arguments:Parameter Type Description rolename
string The name of the role. showPrivileges
document Optional. If true
, returns the role’s privileges. Pass this argument as a document:{showPrivileges: true}
.db.getRole()
wraps therolesInfo
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:
The following operation returns role inheritance information and privileges
for the role associate
defined on the products
database: