db.updateUser（）

定义¶

db.updateUser（用户名，更新，writeConcern ）¶

在运行方法的数据库上更新用户的配置文件。对字段的更新将完全替换前一个字段的值。这包括对用户roles阵列的更新。

警告

更新roles数组时，将完全替换以前的数组的值。要添加或删除角色而不替换所有用户现有角色，请使用db.grantRolesToUser()或 db.revokeRolesFromUser()方法。

该db.updateUser()方法使用以下语法：

小费

从mongoShell的4.2版本开始，您可以将该passwordPrompt()方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。但是，您仍然可以像在早期版本的mongoShell中一样直接指定密码 。

复制

db.updateUser(
   "<username>",
   {
     customData : { <any information> },
     roles : [
       { role: "<role>", db: "<database>" } | "<role>",
       ...
     ],
     pwd: passwordPrompt(),      // Or  "<cleartext password>"
     authenticationRestrictions: [
        {
          clientSource: ["<IP>" | "<CIDR range>", ...],
          serverAddress: ["<IP>", | "<CIDR range>", ...]
        },
        ...
     ],
     mechanisms: [ "<SCRAM-SHA-1|SCRAM-SHA-256>", ... ],
     passwordDigestor: "<server|client>"
   },
   writeConcern: { <write concern> }
)

该db.updateUser()方法具有以下参数。

参数	类型	描述
username	串	要更新的用户名。
update	文献	包含用户替换数据的文档。该数据完全替代了用户的相应数据。
writeConcern	文献	可选的。更新操作的写入关注级别。该writeConcern文档与getLastError命令使用相同的字段。

该update文档指定了要更新的字段及其新值。update文档中的所有字段都是可选的，但必须至少包含一个字段。

该update文档具有以下字段：

领域	类型	描述
customData	文献	可选的。任何任意信息。
roles	数组	可选的。授予用户的角色。对该roles数组的更新将覆盖以前的数组的值。
pwd	串	可选的。用户密码。该值可以是： 用户密码为明文字符串，或者 passwordPrompt() 提示输入用户密码。 小费 从mongoShell的4.2版本开始，您可以将该passwordPrompt()方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。但是，您仍然可以像在早期版本的mongoShell中一样直接指定密码 。
authenticationRestrictions	数组	可选的。服务器对用户实施的身份验证限制。指定允许用户连接到服务器或服务器可以接受用户的IP地址和CIDR范围的列表 。 3.6版的新功能。
mechanisms	数组	可选的。用户凭证的一种或多种特定SCRAM机制。如果authenticationMechanisms指定，则只能指定的子集authenticationMechanisms。 如果在不使用密码的情况下更新“机制”字段，则只能指定用户当前机制的子集，并且仅保留指定机制的现有用户凭据。 如果与机制一起更新密码，则会为用户存储一组新的凭据。 有效值为： "SCRAM-SHA-1" 使用SHA-1哈希函数。 "SCRAM-SHA-256" 使用SHA-256哈希函数。 要求featureCompatibilityVersion设置为4.0。 要求passwordDigestor为server。 版本4.0中的新功能。
passwordDigestor	串	可选的。指示服务器还是客户端提取密码。 可用值为： "server" （默认） 服务器从客户端接收未消化的密码，然后摘要该密码。 "client"（与不兼容SCRAM-SHA-256） 客户端提取密码，然后将提取的密码传递给服务器。 在版本4.0中更改：默认值为"server"。在早期版本中，默认值为"client"。

"readWrite"

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

行为¶

所需的访问权限¶

您必须具有对所有数据库进行操作的访问权限，才能更新用户的阵列。revokeRole roles

你必须有动作角色的数据库上的角色添加到用户。grantRole

要更改另一个用户pwd或customData字段，您必须在该用户的数据库上分别具有changeAnyPassword和changeAnyCustomData 操作。

要修改自己的密码和自定义数据，您必须具有分别在用户数据库上授予changeOwnPassword和 操作的特权。changeOwnCustomData

例子¶

考虑到用户appClient01在products用下面的用户信息数据库：

{
   _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"
   ],
   authenticationRestrictions : [ {
      clientSource: ["69.89.31.226"],
      serverAddress: ["172.16.254.1"]
   } ]
}

以下db.updateUser()方法完全替换了用户customData和roles数据：

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

用户appClient01在products数据库中现在有下列用户信息：

{
   _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"
   ],
   authenticationRestrictions : [ {
      clientSource: ["69.89.31.226"],
      serverAddress: ["172.16.254.1"]
   } ]
}

use reporting
db.updateUser(
   "reportUser256",
   {
     mechanisms: [ "SCRAM-SHA-256" ]
   }
)