db.updateUser() (método mongosh)

Definición

db.updateUser( username, update, writeConcern )

Actualiza el perfil del usuario en la base de datos donde se ejecuta el método. Una actualización de un campo reemplaza completamente los valores del campo anterior. Esto incluye las actualizaciones de la roles matriz del usuario.

Advertencia

Al actualizar la matriz roles, se reemplazan completamente los valores de la matriz anterior. Para agregar o eliminar roles sin reemplazar todos los roles existentes del usuario, utilice el comando db.grantRolesToUser() o db.revokeRolesFromUser() métodos.

El db.updateUser() El método utiliza la siguiente sintaxis:

Tip

Puedes usar el método passwordPrompt() en conjunto con varios métodos y comandos de gestión de autenticación de usuarios para solicitar la contraseña en lugar de especificar la contraseña directamente en la llamada al método o comando. Sin embargo, aún puedes especificar la contraseña directamente como lo harías con las versiones anteriores del shell mongo.

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

El método tiene los siguientes db.updateUser() argumentos.

Parameter	Tipo	Descripción
username	string	El nombre del usuario a actualizar.
update	Documento	Un documento que contiene los datos de reemplazo del usuario. Estos datos reemplazan completamente los datos correspondientes del usuario.
writeConcern	Documento	Opcional. El nivel de confirmación de escritura (write concern) de la operación. Consulte Especificación de nivel de confirmación de escritura (write concern).

El update documento especifica los campos que se actualizarán y sus nuevos valores. Todos los campos del update documento son opcionales, pero deben incluir al menos uno.

El documento update tiene los siguientes campos:

Campo	Tipo	Descripción
customData	Documento	Opcional. Cualquier información arbitraria.
roles	arreglo	Opcional. Los roles asignados al usuario. Una actualización de la matriz roles anula los valores de la matriz anterior.
pwd	string	Opcional. La contraseña del usuario. El valor puede ser: la contraseña del usuario en string de texto sin formato, o passwordPrompt() para solicitar la contraseña del usuario. Puedes usar el método passwordPrompt() en conjunto con varios métodos y comandos de gestión de autenticación de usuarios para solicitar la contraseña en lugar de especificar la contraseña directamente en la llamada al método o comando. Sin embargo, aún puedes especificar la contraseña directamente como lo harías con las versiones anteriores del shell mongo.
authenticationRestrictions	arreglo	Opcional. Las restricciones de autenticación que el servidor impone al usuario. Especifica una lista de direcciones IP y RangosCIDR desde los cuales el usuario puede conectarse al servidor o desde los cuales el servidor puede aceptar usuarios.
mechanisms	arreglo	Opcional. El mecanismo o mecanismos SCRAM específicos para las credenciales de usuario. Si se especifica, solo se puede especificar un authenticationMechanisms subconjunto authenticationMechanisms de. Si se actualiza el campo de mecanismos sin la contraseña, solo se puede especificar un subconjunto de los mecanismos actuales del usuario y solo se conservan las credenciales de usuario existentes para el mecanismo o los mecanismos especificados. Si se actualiza la contraseña junto con los mecanismos, se almacena un nuevo conjunto de credenciales para el usuario. Los valores válidos son: "SCRAM-SHA-1" Utiliza la función de hash SHA-1. "SCRAM-SHA-256" Utiliza la función de hash SHA-256. Se debe establecer featureCompatibilityVersion en 4.0. Requiere que passwordDigestor sea server.
passwordDigestor	string	Opcional. Indica si el servidor o el cliente procesa la contraseña. Los valores disponibles son: "server" (por defecto) El servidor recibe la contraseña sin procesar del cliente y la procesa. "client" (No es compatible con SCRAM-SHA-256) El cliente procesa la contraseña y la pasa al servidor.

"readWrite"

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

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Comportamiento

Acceso requerido

Debe tener acceso que incluya la revokeRole acción en todas las bases de datos para poder actualizar la matriz roles de un usuario.

Debe tener la grantRole acción en la base de datos de un rol para agregar un rol a un usuario.

Para cambiar el campo pwd o de otro customData usuario, debe tener las changePassword acciones changeCustomData y respectivamente en la base de datos de ese usuario.

Para modificar su propia contraseña y datos personalizados, debe tener privilegios que otorguen changeOwnPassword y changeOwnCustomData acciones respectivamente en la base de datos del usuario.

Ejemplo

Dado un usuario appClient01 en la base de datos products con la siguiente información de usuario:

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

El siguiente db.updateUser() método reemplaza completamente customData los roles datos y del usuario:

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

El usuario appClient01 en la base de datos products ahora tiene la siguiente información de usuario:

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