db.createRole() (método de mongosh)

Definición

db.createRole(role, writeConcern)

Crea un rol en una base de datos. Puedes especificar los privilegios para el rol listando explícitamente los privilegios o haciendo que el rol herede privilegios de otros roles, o ambas cosas. El rol se aplica a la base de datos en la que ejecutes el método.

Importante

Método mongosh

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

Para el comando de base de datos, consulta el comando createRole.

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

The db.createRole() method accepts the following arguments:

Parameter	Tipo	Descripción
role	Documento	Un documento que contiene el nombre del rol y la definición del rol.
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 role tiene la siguiente forma:

{
  role: "<name>",
  privileges: [
     { resource: { <resource> }, actions: [ "<action>", ... ] },
     ...
  ],
  roles: [
     { role: "<role>", db: "<database>" } | "<role>",
      ...
  ],
  authenticationRestrictions: [
    {
      clientSource: ["<IP>" | "<CIDR range>", ...],
      serverAddress: ["<IP>" | "<CIDR range>", ...]
    },
    ...
  ]
}

El documento role tiene los siguientes campos:

Campo	Tipo	Descripción
role	string	El nombre del nuevo rol.
privileges	arreglo	Los privilegios para otorgar el rol. Un privilegio consiste en un recurso y acciones permitidas. Para la sintaxis de un privilegio, consulta la privileges arreglo. Es obligatorio incluir el campo privileges. Utilice un arreglo vacío para especificar ningún privilegio.
roles	arreglo	Un arreglo de roles de los cuales este rol hereda privilegios. Debe incluir el campo roles. Utiliza un arreglo vacío para especificar que no se heredarán roles.
authenticationRestrictions	arreglo	Opcional. Las restricciones de autenticación que el servidor aplica al rol. Especifica una lista de direcciones IP y rangos CIDR a los que los usuarios con este rol pueden conectarse y/o desde los que pueden conectarse.

"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

privileges: [
     {
     resource: { db: 'products', collection: 'coll1' },
     actions: [ 'bypassDocumentValidation' ]
     },
     {
     resource: { db: 'products', collection: 'coll2' },
     actions: [ 'bypassDocumentValidation' ]
     }
]

privileges: [
     {
     resource: { db: 'products', collection: '' },
     actions: [ 'bypassDocumentValidation' ]
     }
]

Acceso requerido

Para crear un rol en una base de datos, se debe tener:

• la acción createRole sobre ese recurso de base de datos.

• la acción grantRole en esa base de datos para especificar los privilegios del nuevo rol, así como para especificar los roles de los que heredará.

Los roles de funcionalidad incorporada userAdmin y userAdminAnyDatabase proporcionan acciones createRole y grantRole sobre sus respectivos recursos.

Para crear un rol con authenticationRestrictions especificado, debes tener la acción setAuthenticationRestriction sobre el recurso de base de datos en el que se crea el rol.

Ejemplo

The following db.createRole() method creates the myClusterwideAdmin role on the admin database:

use admin
db.createRole(
   {
     role: "myClusterwideAdmin",
     privileges: [
       { resource: { cluster: true }, actions: [ "addShard" ] },
       { resource: { db: "config", collection: "" }, actions: [ "find", "update", "insert", "remove" ] },
       { resource: { db: "users", collection: "usersCollection" }, actions: [ "update", "insert", "remove" ] },
       { resource: { db: "", collection: "" }, actions: [ "find" ] }
     ],
     roles: [
       { role: "read", db: "admin" }
     ]
   },
   { w: "majority" , wtimeout: 5000 }
)