db.grantRolesToUser()

Definition定义

db.grantRolesToUser(username, roles, writeConcern)

Grants additional roles to a user.将其他角色授予用户。

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the grantRolesToUser command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

The db.grantRolesToUser() method uses the following syntax:db.grantRolesToUser()方法使用以下语法：

db.grantRolesToUser( "<username>", [ <roles> ], { <writeConcern> } )

The db.grantRolesToUser() method takes the following arguments:db.grantRolesToUser()方法采用以下参数：

Parameter参数	Type类型	Description描述
user	string	The name of the user to whom to grant roles.要向其授予角色的用户的名称。
roles	array	An array of additional roles to grant to the user.要授予用户的附加角色的数组。
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.在roles字段中，可以指定内置角色和用户定义的角色。

To specify a role that exists in the same database where db.grantRolesToUser() runs, you can either specify the role with the name of the role:要指定运行db.grantRolesToUser()的同一数据库中存在的角色，可以使用角色名称指定该角色：

"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.grantRolesToUser() method wraps the grantRolesToUser command.db.grantRolesToUser()方法包装grantRolesToUser命令。

Behavior行为

Required Access所需访问权限

You must have the grantRole action on a database to grant a role on that database.必须对数据库执行grantRole操作才能在该数据库上授予角色。

Example实例

Given a user accountUser01 in the products database with the following roles:给定products数据库中具有以下角色的用户accountUser01：

"roles" : [
    { "role" : "assetsReader",
      "db" : "assets"
    }
]

The following db.grantRolesToUser() operation gives accountUser01 the readWrite role on the products database and the read role on the stock database.下面的db.grantRolesToUser()操作为accountUser01提供了products数据库上的readWrite角色和stock数据库上的read角色。

use products
db.grantRolesToUser(
   "accountUser01",
   [ "readWrite" , { role: "read", db: "stock" } ],
   { w: "majority" , wtimeout: 4000 }
)

The user accountUser01 in the products database now has the following roles:products数据库中的用户accountUser01现在具有以下角色：

"roles" : [
    { "role" : "assetsReader",
      "db" : "assets"
    },
    { "role" : "read",
      "db" : "stock"
    },
    { "role" : "readWrite",
      "db" : "products"
    }
]