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.

Warning

When you update the roles array, you completely replace the previous array’s values. To add or remove roles without replacing all the user’s existing roles, use the grantRolesToUser or revokeRolesFromUser commands.

The updateUser command uses the following syntax. To update a user, you must specify the updateUser field and at least one other field, other than writeConcern:

Tip

Starting in version 4.2 of the mongo shell, you can use the passwordPrompt() method in conjunction with various user authentication/management methods/commands to prompt for the password instead of specifying the password directly in the method/command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.

{
  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>
}

The command has the following fields:

Field字段	Type类型	Description描述
updateUser	string	The name of the user to update.
pwd	string	Optional.可选。The user’s password. The value can be either: the user’s password in cleartext string, or passwordPrompt() to prompt for the user’s password. Tip Starting in version 4.2 of the mongo shell, you can use the passwordPrompt() method in conjunction with various user authentication/management methods/commands to prompt for the password instead of specifying the password directly in the method/command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.
customData	document	Optional.可选。Any arbitrary information.
roles	array	Optional.可选。The roles granted to the user. An update to the roles array overrides the previous array’s values.
writeConcern	document	Optional.可选。The level of write concern for the update operation. The writeConcern document takes the same fields as the getLastError command.
authenticationRestrictions	array	Optional.可选。The authentication restrictions the server enforces upon the user. Specifies a list of IP addresses and CIDR ranges from which the user is allowed to connect to the server or from which the server can accept users. New in version 3.6.版本3.6中的新功能。
mechanisms	array	Optional.可选。The specific SCRAM mechanism or mechanisms for the user credentials. If authenticationMechanisms is specified, you can only specify a subset of the authenticationMechanisms. If updating the mechanisms field without the password, you can only specify a subset of the user’s current mechanisms, and only the existing user credentials for the specified mechanism or mechanisms are retained. If updating the password along with the mechanisms, new set of credentials are stored for the user. Valid values are: "SCRAM-SHA-1" Uses the SHA-1 hashing function. "SCRAM-SHA-256" Uses the SHA-256 hashing function. Requires featureCompatibilityVersion set to 4.0. Requires digestPassword to be true. New in version 4.0.版本4.0中的新功能。
digestPassword	boolean	Optional.可选。Indicates whether the server or the client digests the password. If true, the server receives undigested password from the client and digests the password. If false, the client digests the password and passes the digested password to the server. Not compatible with SCRAM-SHA-256 Changed in version 4.0.在版本4.0中更改。The default value is true. In earlier versions, the default value is false.
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行为¶

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 changeAnyPassword and changeAnyCustomData 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"), // Starting in MongoDB 4.0.9
   "user" : "appClient01",
   "db" : "products",
   "customData" : { "empID" : "12345", "badge" : "9156" },
   "roles" : [
       { "role" : "readWrite",
         "db" : "products"
       },
       { "role" : "read",
         "db" : "inventory"
       }
   ],
   "mechanisms" : [   // Starting in MongoDB 4.0
      "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"), // Starting in MongoDB 4.0.9
   "user" : "appClient01",
   "db" : "products",
   "customData" : { "employeeId" : "0x3039" },
   "roles" : [
       { "role" : "read",
         "db" : "assets"
       }
   ],
   "mechanisms" : [   // Starting in MongoDB 4.0
      "SCRAM-SHA-1",
      "SCRAM-SHA-256"
   ]

}