db.getRoles()

在本页面

Definition

  • db. getRoles ( )
    • 返回运行命令的数据库中所有角色的信息。该方法可以带或不带参数运行。

如果不带参数运行,则db.getRoles()返回数据库user-defined角色的继承信息。

要返回更多信息,请将以下字段传递给db.getRoles()文档:

FieldTypeDescription
rolesInfointeger将此字段设置为1以检索所有用户定义的角色。
showPrivilegesboolean可选的。将字段设置为true以显示角色特权,包括从其他角色继承的特权和直接定义的特权。默认情况下,该命令仅返回该角色从中继承特权的角色,并且不返回特定特权。
showBuiltinRolesboolean可选的。设置为 true 以显示built-in roles以及用户定义的角色。

db.getRoles()包装rolesInfo命令。

Required Access

要查看角色的信息,必须为您明确授予该角色或在角色的数据库上具有viewRole action

Example

以下操作返回products数据库上所有角色的文档,包括角色特权和内置角色:

db.getRoles(
    {
      rolesInfo: 1,
      showPrivileges:true,
      showBuiltinRoles: true
    }
)