On this page

• Definition
• Behavior
• Required Access
• Example

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:

copy

{
  updateUser: "<username>",
  pwd: "<cleartext password>",
  customData: { <any information> },
  roles: [
    { role: "<role>", db: "<database>" } | "<role>",
    ...
  ],
  writeConcern: { <write concern> }
}

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.
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.
digestPassword	boolean	Optional. When true, the mongod instance will create the hash of the user password; otherwise, the client is responsible for creating the hash of the password. Defaults to true.
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.

"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 3.6.13
   "user" : "appClient01",
   "db" : "products",
   "credentials" : {
         "SCRAM-SHA-1" : {
            "iterationCount" : 10000,
            "salt" : "vXYL9Q3NnfZjLHCOej0NLQ==",
            "storedKey" : "Bw0MXnC1hEBbM3lDebatMRZSokQ=",
            "serverKey" : "tzvPqiB7ynqji5kmrCiAkUrke+Q="
         }
      },
   "customData" : { "empID" : "12345", "badge" : "9156" },
   "roles" : [
       { "role" : "readWrite",
         "db" : "products"
       },
       { "role" : "read",
         "db" : "inventory"
       }
   ]
}

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 3.6.13
   "user" : "appClient01",
   "db" : "products",
   "credentials" : {
      "SCRAM-SHA-1" : {
         "iterationCount" : 10000,
         "salt" : "vXYL9Q3NnfZjLHCOej0NLQ==",
         "storedKey" : "Bw0MXnC1hEBbM3lDebatMRZSokQ=",
         "serverKey" : "tzvPqiB7ynqji5kmrCiAkUrke+Q="
      }
   },
   "roles" : [
       { "role" : "read",
         "db" : "assets"
       }
   ],
   "customData" : { "employeeId" : "0x3039" }
}