updateRole (comando de base de datos)

Definición

updateRole

Updates a rol definido por el usuario. La updateRole el comando debe ejecutarse en la base de datos del rol.

Tip

En mongosh, este comando también se puede ejecutar a través del método asistente db.updateRole().

Los métodos asistente son convenientes para usuarios de mongosh, pero es posible que no proporcionen el mismo nivel de información que los comandos de base de datos. En los casos en que no se necesite la conveniencia o se requieran campos de retorno adicionales, utiliza el comando de base de datos.

Actualizar un campo reemplaza completamente los valores anteriores de ese campo. Para conceder o remover roles o privilegios sin reemplazar todos los valores, utilice uno o más de los siguientes comandos:

• grantRolesToRole

• grantPrivilegesToRole

• revokeRolesFromRole

• revokePrivilegesFromRole

Advertencia

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

Compatibilidad

Este comando 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.

Sintaxis

Para actualizar un rol, debes proporcionar el privileges arreglo, el roles arreglo o ambos.

El comando utiliza la siguiente sintaxis:

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

Campos de comandos

El comando toma los siguientes campos:

"readWrite"

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

Comportamiento

Los privilegios de un rol se aplican a la base de datos donde se creó. El rol puede heredar privilegios de otros roles en su base de datos. Un rol creado en la admin base de datos puede incluir privilegios que se aplican a todas las bases de datos o al clúster, y puede heredar privilegios de roles en otras bases de datos.

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 es un ejemplo del comando updateRole que actualiza el rol myClusterwideAdmin en la base de datos admin. Si bien los arreglos privileges y roles son ambos opcionales, se requiere al menos uno de los dos:

db.adminCommand(
   {
     updateRole: "myClusterwideAdmin",
     privileges:
         [
           {
             resource: { db: "", collection: "" },
             actions: [ "find" , "update", "insert", "remove" ]
           }
         ],
     roles:
         [
           { role: "dbAdminAnyDatabase", db: "admin" }
         ],
     writeConcern: { w: "majority" }
   }
)

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