db.updateRole() (método mongosh)

Definición

db.updateRole( rolename, update, writeConcern )

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

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 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 anteriores del campo. Para conceder o remover roles o privilegios sin reemplazar todos los valores, utiliza uno o más de los siguientes métodos:

• db.grantRolesToRole()

• db.grantPrivilegesToRole()

• db.revokeRolesFromRole()

• db.revokePrivilegesFromRole()

Advertencia

Una actualización en el arreglo privileges o roles reemplaza completamente los valores anteriores del arreglo.

The db.updateRole() method uses the following syntax:

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

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

Parameter	Tipo	Descripción
rolename	string	El nombre del rol definido por el usuario que se debe 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 rangos CIDR a los que los usuarios con este rol pueden conectarse y/o desde los que pueden conectarse.

The db.updateRole() method wraps the updateRole command.

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 en el arreglo privileges para actualizar el arreglo. Si uno de los recursos de un privilegio abarca bases de datos, debes tener grantRole en la base de datos admin. Un privilegio abarca bases de datos si el privilegio es cualquiera de los siguientes:

• 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

The following db.updateRole() method replaces the privileges and the roles for the inventoryControl role that exists in the products database. The method runs on the database that contains inventoryControl:

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.