db.revokeRolesFromUser()

On this page本页内容

Definition定义

db.revokeRolesFromUser()

Removes a one or more roles from a user on the current database. 从当前数据库的用户中删除一个或多个角色。The db.revokeRolesFromUser() method uses the following syntax:db.revokeRolesFromUser()方法使用以下语法:

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

The revokeRolesFromUser method takes the following arguments:revokeRolesFromUser方法采用以下参数:

Parameter参数Type类型Description描述
user string The name of the user from whom to revoke roles.要从中撤消角色的用户的名称。
roles array The roles to remove from the user.要从用户中删除的角色。
writeConcern document Optional.可选。The level of write concern for the modification. 修改的写入关注级别。The writeConcern document takes the same fields as the getLastError command.writeConcern文档采用与getLastError命令相同的字段。

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.revokeRolesFromUser() runs, you can either specify the role with the name of the role:要指定运行db.revokeRolesFromUser()的同一数据库中存在的角色,可以使用该角色的名称指定该角色:

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

Behavior行为

Replica set复制集

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

Required Access所需访问权限

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

Example示例

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

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

The following db.revokeRolesFromUser() method removes the two of the user’s roles: the read role on the stock database and the readWrite role on the products database, which is also the database on which the method runs:以下db.revokeRolesFromUser()方法删除了用户的两个角色:stock数据库上的read角色和products数据库上的readWrite角色,产品数据库也是该方法运行的数据库:

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

The user accountUser01 user in the products database now has only one remaining role:products数据库中的用户accountUser01用户现在只剩下一个角色:

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