db.updateRole() (método mongosh)

Definición

db.updateRole( rolename, update, writeConcern )

Updates a rol definido por el usuario. El método db.updateRole() debe ejecutarse en la base de datos del rol.

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, consulta el comando updateRole.

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

Una actualización de un campo reemplaza completamente los valores del campo anterior. Para otorgar o eliminar roles o privilegios sin reemplazar todos los valores, utilice uno o más de los siguientes métodos:

• db.grantRolesToRole()

• db.grantPrivilegesToRole()

• db.revokeRolesFromRole()

• db.revokePrivilegesFromRole()

Advertencia

Una actualización de la matriz privileges o roles reemplaza completamente los valores de la matriz anterior.

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

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

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

Parameter	Tipo	Descripción
rolename	string	El nombre del rol definido por el usuario que se actualizará.
update	Documento	Un documento que contiene los datos de reemplazo para el rol. Estos datos reemplazan completamente los datos correspondientes para el 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 update especifica los campos que se deben actualizar y los nuevos valores. Cada campo en el documento update es opcional, pero el documento debe incluir al menos un campo. El documento update contiene los siguientes campos:

Campo	Tipo	Descripción
privileges	arreglo	opcional. Se requiere si no especifica el roles arreglo. Los privilegios para otorgar el rol. Una actualización del arreglo privileges anula los valores anteriores del arreglo. Para conocer la sintaxis para especificar un privilegio, consulte el privileges arreglo.
roles	arreglo	opcional. Se requiere si no especifica el privileges arreglo. Los roles de los cuales este rol hereda privilegios. Una actualización en el arreglo roles anula los valores anteriores del arreglo.
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.

El método db.updateRole() envuelve el comando updateRole.

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.

"readWrite"

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

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

Debes tener la revokeRole acción en todas las bases de datos para actualizar un rol.

Debes tener la grantRole acción en la base de datos de cada rol en el arreglo roles para actualizar el arreglo.

Debe tener la grantRole acción en la base de datos de cada privilegio de la privileges matriz para actualizarla. Si el recurso de un privilegio abarca varias bases de datos, debe tener en grantRole la admin base de datos. Un privilegio abarca varias bases de datos si cumple alguno de los siguientes requisitos:

• una colección en todas las bases de datos

• todas las colecciones y todas las bases de datos

• el recurso cluster

Debe tener la setAuthenticationRestriction acción en la base de datos del rol de destino para actualizar el documento authenticationRestrictions de un rol.

Ejemplo

El siguiente db.updateRole() método reemplaza y para privileges roles el inventoryControl rol existente en la products base de datos. El método se ejecuta en la base de datos que inventoryControl contiene:

use products
db.updateRole(
    "inventoryControl",
    {
      privileges:
          [
            {
              resource: { db:"products", collection:"clothing" },
              actions: [ "update", "createCollection", "createIndex"]
            }
          ],
      roles:
          [
            {
              role: "read",
              db: "products"
            }
          ]
    },
    { w:"majority" }
)

Para ver los privilegios de un rol, se utiliza el comando rolesInfo.