updateUser

Definition定义

updateUser

Updates the user's profile on the database on which you run the command. 在运行命令的数据库上更新用户的配置文件。An update to a field completely replaces the previous field's values, including updates to the user's roles and authenticationRestrictions arrays.对字段的更新将完全替换上一个字段的值，包括对用户roles和authenticationRestrictions数组的更新。

Tip

In mongosh, this command can also be run through the db.changeUserPassword() helper method.在mongosh中，这个命令也可以通过db.changeUserPassword()助手方法运行。

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. 助手方法对mongosh用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。In cases where the convenience is not needed or the additional return fields are required, use the database command.如果不需要方便，或者需要额外的返回字段，请使用数据库命令。

Warning

When you update the roles array, you completely replace the previous array's values. 更新roles数组时，将完全替换上一个数组的值。To add or remove roles without replacing all the user's existing roles, use the grantRolesToUser or revokeRolesFromUser commands.要添加或删除角色而不替换用户的所有现有角色，请使用grantRolesToUser或revokeRolesFromUser命令。

To update a user, you must specify the updateUser field and at least one other field, other than writeConcern.若要更新用户，必须指定updateUser字段和除writeConcern之外的至少一个其他字段。

Syntax语法

The command uses the following syntax:该命令使用以下语法：

 db.runCommand(
    {
      updateUser: "<username>",
      pwd: passwordPrompt(),      // Or  "<cleartext password>"
      customData: { <any information> },
      roles: [
        { role: "<role>", db: "<database>" } | "<role>",
        ...
      ],
      authenticationRestrictions: [
         {
           clientSource: ["<IP>" | "<CIDR range>", ...],
           serverAddress: ["<IP>", | "<CIDR range>", ...]
         },
         ...
      ],
      mechanisms: [ "<scram-mechanism>", ... ],
      digestPassword: <boolean>,
      writeConcern: { <write concern> },
      comment: <any>
    }
)

Command Fields命令字段

The command takes the following fields:该命令包含以下字段：

"readWrite"

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

Behavior行为

Required Access所需访问权限

You must have access that includes the revokeRole action on all databases in order to update a user's roles array.

You must have the grantRole action on a role's database to add a role to a user.

To change another user's pwd or customData field, you must have the changePassword and changeCustomData actions respectively on that user's database.

To modify your own password and custom data, you must have privileges that grant changeOwnPassword and changeOwnCustomData actions respectively on the user's database.

Example实例

Given a user appClient01 in the products database with the following user info:

{
   "_id" : "products.appClient01",
   "userId" : UUID("c5d88855-3f1e-46cb-9c8b-269bef957986"),
   "user" : "appClient01",
   "db" : "products",
   "customData" : { "empID" : "12345", "badge" : "9156" },
   "roles" : [
       { "role" : "readWrite",
         "db" : "products"
       },
       { "role" : "read",
         "db" : "inventory"
       }
   ],
   "mechanisms" : [
      "SCRAM-SHA-1",
      "SCRAM-SHA-256"
   ]
}

The following updateUser command completely replaces the user's customData and roles data:

use products
db.runCommand( {
   updateUser : "appClient01",
   customData : { employeeId : "0x3039" },
   roles : [ { role : "read", db : "assets" } ]
} )

The user appClient01 in the products database now has the following user information:

{
   "_id" : "products.appClient01",
   "userId" : UUID("c5d88855-3f1e-46cb-9c8b-269bef957986"),
   "user" : "appClient01",
   "db" : "products",
   "customData" : { "employeeId" : "0x3039" },
   "roles" : [
       { "role" : "read",
         "db" : "assets"
       }
   ],
   "mechanisms" : [
      "SCRAM-SHA-1",
      "SCRAM-SHA-256"
   ]

}