db.createRole() (método mongosh)

Definición

db.createRole(role, writeConcern)

Crea un rol en una base de datos. Puede especificar privilegios para el rol enumerándolos explícitamente, haciendo que herede los privilegios de otros roles o ambas cosas. El rol se aplica a la base de datos donde se ejecuta el método.

Importante

Método mongosh

Esta página documenta una mongosh Método. Esta no es la documentación para comandos de base de datos ni para controladores específicos del lenguaje, como Node.js.

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

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

El método acepta los siguientes db.createRole() argumentos:

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 el siguiente formato:

{
  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 consta de un recurso y las acciones permitidas. Para conocer la sintaxis de un privilegio, consulte la privileges matriz. Debe incluir el privileges campo. Use una matriz vacía para especificar que no hay privilegios.
roles	arreglo	Una serie de roles de los cuales este rol hereda privilegios. Debe incluir el roles campo. Use una matriz vacía para especificar que no hay roles de los que heredar.
authenticationRestrictions	arreglo	Opcional. Las restricciones de autenticación que el servidor aplica al rol. Especifica una lista de direcciones IP y Los rangosCIDR a los que se les otorga este rol pueden conectarse y/o desde los cuales 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

El siguiente método crea db.createRole() el myClusterwideAdmin rol en la admin base de datos:

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