updateUser (Update User)
Last updated: 2026-10-09
updateUser (Update User)
updateUser modifies an existing user: reset the password, replace roles, or refresh customData. Only the fields passed are changed; roles, however, are replaced wholesale by the new list. In mongosh call db.updateUser(user, { pwd, roles, customData }). Requires userAdmin or root.
| Category | User Authentication |
|---|---|
| MongoDB Version | 1.0+ |
| Example Language | mongosh (Shell) |
📝 Syntax
db.updateUser("<username>", { pwd: "<new password>" })
db.updateUser("<username>", { roles: [ { role: "readWrite", db: "shop" } ] })⚙️ Parameters
| pwd | The new password |
|---|---|
| roles | New role list, replacing old roles entirely |
| customData | Arbitrary custom metadata |
Returns：Returns { ok: 1 } on success
▶ Example
Run the commands below in your local mongosh (requires a running mongod):
// updateUser: reset password and set roles
use admin
db.updateUser('reader', {
pwd: 'newpass456',
roles: [ { role: 'read', db: 'shop' }, { role: 'read', db: 'analytics' } ]
})Output：
{ ok: 1 }📌 Notes
- Only the fields you pass are updated
- roles replace the full list — omitted old roles are lost
- Requires userAdmin or root
🏷️ Related Tags
💡 Related Cases
More hands-on cases coming soon.
📚 Related Tutorials
❓ FAQ
QDoes updateUser overwrite roles?
AYes — roles replace the whole list, so include every role you want to keep.
QHow do I change only the password?
APass only pwd; everything else stays as is.
QWhat privileges does this need?
AuserAdmin on the database, or root.
