updateRole¶

Definition定义¶

updateRole¶

Updates a user-defined role. The updateRole command must run on the role’s database.

An update to a field completely replaces the previous field’s values. To grant or remove roles or privileges without replacing all values, use one or more of the following commands:

• grantRolesToRole
• grantPrivilegesToRole
• revokeRolesFromRole
• revokePrivilegesFromRole

Warning

An update to the privileges or roles array completely replaces the previous array’s values.

The updateRole command uses the following syntax. To update a role, you must provide the privileges array, roles array, or both:

{
  updateRole: "<role>",
  privileges:
      [
        { resource: { <resource> }, actions: [ "<action>", ... ] },
        ...
      ],
  roles:
      [
        { role: "<role>", db: "<database>" } | "<role>",
        ...
      ],
  authenticationRestrictions:
      [
        {
          clientSource: ["<IP>" | "<CIDR range>", ...],
          serverAddress: ["<IP>", ...]
        },
        ...
      ]
  writeConcern: <write concern document>,
  comment: <any>
}

The updateRole command has the following fields:

Field字段	Type类型	Description描述
updateRole	string	The name of the user-defined role role to update.
privileges	array	Optional.可选。Required if you do not specify roles array. The privileges to grant the role. An update to the privileges array overrides the previous array’s values. For the syntax for specifying a privilege, see the privileges array.
roles	array	Optional.可选。Required if you do not specify privileges array. The roles from which this role inherits privileges. An update to the roles array overrides the previous array’s values.
authenticationRestrictions	array	Optional. The authentication restrictions the server enforces on the role. Specifies a list of IP addresses and CIDR ranges users granted this role are allowed to connect to and/or which they can connect from. New in version 3.6.版本3.6中的新功能。
writeConcern	document	Optional.可选。The level of write concern for the update operation. The writeConcern document takes the same fields as the getLastError command.
comment	any	Optional.可选。A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations: mongod log messages, in the attr.command.cursor.comment field. Database profiler output, in the command.comment field. currentOp output, in the command.comment field. A comment can be any valid BSON type (string, integer, object, array, etc). New in version 4.4.版本4.4中的新功能。

"readWrite"

{ role: "<role>", db: "<database>" }

Behavior行为¶

A role’s privileges apply to the database where the role is created. The role can inherit privileges from other roles in its database. A role created on the admin database can include privileges that apply to all databases or to the cluster and can inherit privileges from roles in other databases.

Required Access¶

You must have the revokeRole action on all databases in order to update a role.

You must have the grantRole action on the database of each role in the roles array to update the array.

You must have the grantRole action on the database of each privilege in the privileges array to update the array. If a privilege’s resource spans databases, you must have grantRole on the admin database. A privilege spans databases if the privilege is any of the following:

• a collection in all databases
• all collections and all database
• the cluster resource

You must have the setAuthenticationRestriction action on the database of the target role to update a role’s authenticationRestrictions document.

Example示例¶

The following is an example of the updateRole command that updates the myClusterwideAdmin role on the admin database. While the privileges and the roles arrays are both optional, at least one of the two is required:

db.adminCommand(
   {
     updateRole: "myClusterwideAdmin",
     privileges:
         [
           {
             resource: { db: "", collection: "" },
             actions: [ "find" , "update", "insert", "remove" ]
           }
         ],
     roles:
         [
           { role: "dbAdminAnyDatabase", db: "admin" }
         ],
     writeConcern: { w: "majority" }
   }
)

To view a role’s privileges, use the rolesInfo command.