Docs HomeMongoDB Manual

db.revokeRolesFromRole()

Definition定义

db.revokeRolesFromRole(rolename, roles, writeConcern)

Removes the specified inherited roles from a role.从角色中删除指定的继承角色。

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 revokeRolesFromRole 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.revokeRolesFromRole() method uses the following syntax:db.revokeRolesFromRole()方法使用以下语法:

db.revokeRolesFromRole( "<rolename>", [ <roles> ], { <writeConcern> } )

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

Parameter参数Type类型Description描述
rolenamestringThe name of the role from which to revoke roles.要从中吊销角色的角色的名称。
rolesarrayThe inherited roles to remove.要删除的继承角色。
writeConcerndocumentOptional.可选的。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.revokeRolesFromRole() runs, you can either specify the role with the name of the role:要指定运行db.revokeRolesFromRole()的同一数据库中存在的角色,可以使用角色名称指定该角色:

"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.若要指定其他数据库中存在的角色,请使用文档指定该角色。

Behavior行为

Replica set副本集

If run on a replica set, db.revokeRolesFromRole() is executed using "majority" write concern by default.如果在副本集上运行,db.revokeRolesFromRole()在默认情况下使用"majority"写入关注执行。

Required Access所需访问权限

You must have the revokeRole action on a database to revoke a role on that database.必须对数据库执行revokeRole操作才能吊销该数据库中的角色。

Example实例

The purchaseAgents role in the emea database inherits privileges from several other roles, as listed in the roles array:emea数据库中的purchaseAgents角色继承了其他几个角色的权限,如roles数组中所列:

{
"_id" : "emea.purchaseAgents",
"role" : "purchaseAgents",
"db" : "emea",
"privileges" : [],
"roles" : [
{
"role" : "readOrdersCollection",
"db" : "emea"
},
{
"role" : "readAccountsCollection",
"db" : "emea"
},
{
"role" : "writeOrdersCollection",
"db" : "emea"
}
]
}

The following db.revokeRolesFromRole() operation on the emea database removes two roles from the purchaseAgents role:以下对emea数据库的db.revokeRolesFromRole()操作将从purchaseAgents角色中删除两个角色:

use emea
db.revokeRolesFromRole( "purchaseAgents",
[
"writeOrdersCollection",
"readOrdersCollection"
],
{ w: "majority" , wtimeout: 5000 }
)

The purchaseAgents role now contains just one role:purchaseAgents角色现在只包含一个角色:

{
"_id" : "emea.purchaseAgents",
"role" : "purchaseAgents",
"db" : "emea",
"privileges" : [],
"roles" : [
{
"role" : "readAccountsCollection",
"db" : "emea"
}
]
}