db.updateUser()

定义

db.updateUser( username, update, writeConcern )

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

警告

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

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

提示

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

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() 方法的参数如下。

Parameter	类型	说明
username	字符串	要更新的用户的名称。
update	文档	一份包含该用户替换数据的文档。该数据完全替代该用户的相应数据。
writeConcern	文档	可选。操作的写关注级别。请参阅写关注规范。

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

update 文档包含以下字段：

字段	类型	说明
customData	文档	可选。任意信息。
roles	阵列	可选。 授予用户的角色。 roles数组的更新会覆盖之前数组的值。
pwd	字符串	可选。用户的密码。该值可为： 以明文字符串表示的用户密码，或 passwordPrompt() 提示输入用户密码。 您可以将passwordPrompt()方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。 但是，您仍然可以像使用早期版本的mongo shell一样直接指定密码。
authenticationRestrictions	阵列	可选。服务器对用户实施的身份验证限制。指定 IP 地址和 CIDR 范围列表，允许这些地址和范围的用户连接至服务器或者服务器接受这些用户。 版本 3.6 中的新增功能。
mechanisms	阵列	可选。针对用户档案的特定 SCRAM 机制。如果指定了 authenticationMechanisms，则只能指定部分 authenticationMechanisms。 如果在没有密码的情况下更新机制字段，则只能指定用户当前机制的子集，并且仅保留指定机制或机制的现有用户档案。 如果同时更新密码和机制，则会为用户存储一组新的档案。 有效值为： "SCRAM-SHA-1" 使用 SHA-1 哈希函数。 "SCRAM-SHA-256" 使用 SHA-256 哈希函数。 需将 featureCompatibilityVersion 设为 4.0。 要求 passwordDigestor 为server。
passwordDigestor	字符串	可选。指示对密码进行摘要处理的是服务器还是客户端。 可用值为： "server" （默认） 服务器会从客户端接收未加密的密码，然后对此密码进行加密。 "client" （与 SCRAM-SHA-256 不兼容） 客户端会对该密码进行哈希，并将哈希后的密码传递给服务器。

"readWrite"

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

兼容性

此方法可用于以下环境中托管的部署：

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

行为

必需的访问权限

要更新用户的 roles 数组，您必须具有包含所有数据库上的revokeRole动作的访问权限。

必须对某一角色的数据库执行 grantRole 操作才能向用户添加角色。

要更改其他用户的 pwd 或 customData 字段，必须对该用户的数据库分别执行 changePassword 和 changeCustomData 操作。

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

例子

假定在 products 数据库中有用户 appClient01，其用户信息如下：

{
   _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"
   ],
   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"  }
   ]
} )

products 数据库中的用户 appClient01 现在具有以下用户信息：

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

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