db.createUser() (método mongosh)

Definición

db.createUser(user, writeConcern)

Crea un nuevo usuario para la base de datos en la que se ejecuta el método. db.createUser() devuelve un error de usuario duplicado si el usuario ya existe en la base de datos.

Importante

Método mongosh

Esta página documenta un método mongosh. Esta no es la documentación para los comandos de base de datos ni para los drivers específicos de lenguajes, como Nodo.js.

Para el comando de base de datos, consulte el createUser dominio.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

El método db.createUser() tiene la siguiente sintaxis:

Campo	Tipo	Descripción
user	Documento	El documento con la información de autenticación y acceso sobre el usuario que se va a crear.
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 documento user define al usuario y tiene el siguiente formato:

Tip

Puede usar el método junto con varios métodos o comandos de autenticación/gestión de usuarios para solicitar la contraseña en lugar de especificarla directamente en la llamada al método/comando. Sin embargo, puede especificarla directamente como lo hacía con versiones anteriores passwordPrompt() del mongo shell.

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

El documento user tiene los siguientes campos:

Campo	Tipo	Descripción
user	string	El nombre del nuevo usuario.
pwd	string	La contraseña del usuario. El campo pwd no es obligatorio si ejecutas db.createUser() en la base de datos $external para crear usuarios con credenciales almacenadas externamente a MongoDB. El valor puede ser: la contraseña del usuario en string de texto sin formato, o passwordPrompt() para solicitar la contraseña del usuario. Puede usar el método junto con varios métodos o comandos de autenticación/gestión de usuarios para solicitar la contraseña en lugar de especificarla directamente en la llamada al método/comando. Sin embargo, puede especificarla directamente como lo hacía con versiones anteriores passwordPrompt() del mongo shell.
customData	Documento	Opcional. Cualquier información arbitraria. Este campo puede ser utilizado para almacenar cualquier dato que un administrador quiera asociar con este usuario en particular. Por ejemplo, esto podría ser el nombre completo del usuario o el ID de empleado.
roles	arreglo	Los roles otorgados al usuario. Puede especificar un arreglo vacío [] para crear usuarios sin roles.
Restricciones de autenticación	arreglo	Opcional. Las restricciones de autenticación que el servidor aplica al usuario creado. 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. Especifique el mecanismo o los mecanismos SCRAM para crear credenciales de usuario SCRAM. Si se especifica authenticationMechanisms, solo puede especificar un subconjunto del authenticationMechanisms. 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. Requiere que passwordDigestor sea server. El valor por defecto es tanto SCRAM-SHA-1 como SCRAM-SHA-256.
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

• Para crear un nuevo usuario en una base de datos, debe tener la acción createUser sobre ese recurso de base de datos.

• Para otorgar roles a un usuario, debe tener la acción grantRole en la base de datos del rol.

Los userAdmin y userAdminAnyDatabase roles integrados proporcionan acciones createUser y grantRole sobre sus respectivos recursos.

Ejemplos

La siguiente db.createUser() operación crea el usuario accountAdmin01 en la base de datos products.

use products
db.createUser( { user: "accountAdmin01",
                 pwd: passwordPrompt(),  // Or  "<cleartext password>"
                 customData: { employeeId: 12345 },
                 roles: [ { role: "clusterAdmin", db: "admin" },
                          { role: "readAnyDatabase", db: "admin" },
                          "readWrite"] },
               { w: "majority" , wtimeout: 5000 } )

La operación otorga a accountAdmin01 los siguientes roles:

• los roles clusterAdmin y readAnyDatabase en la base de datos admin

• el rol readWrite en la base de datos products

use products
db.createUser(
   {
     user: "accountUser",
     pwd: passwordPrompt(),  // Or  "<cleartext password>"
     roles: [ "readWrite", "dbAdmin" ]
   }
)

use admin
db.createUser(
   {
     user: "reportsUser",
     pwd: passwordPrompt(),  // Or  "<cleartext password>"
     roles: [ ]
   }
)

use admin
db.createUser(
   {
     user: "appAdmin",
     pwd: passwordPrompt(),   // Or  "<cleartext password>"
     roles:
       [
         { role: "readWrite", db: "config" },
         "clusterAdmin"
       ]
   }
)

use admin
db.createUser(
   {
     user: "restricted",
     pwd: passwordPrompt(),      // Or  "<cleartext password>"
     roles: [ { role: "readWrite", db: "reporting" } ],
     authenticationRestrictions: [ {
        clientSource: ["192.0.2.0"],
        serverAddress: ["198.51.100.0"]
     } ]
   }
)

use reporting
db.createUser(
   {
     user: "reportUser256",
     pwd: passwordPrompt(),   // Or  "<cleartext password>"
     roles: [ { role: "readWrite", db: "reporting" } ],
     mechanisms: [ "SCRAM-SHA-256" ]
   }
)