updateRole

Definição

updateRole

Atualiza umrole definido pelo usuário . O comando updateRole deve ser executado no banco de banco de dados do role.

Dica

Em mongosh, esse comando também pode ser executado por meio do método auxiliar db.updateRole().

Os métodos auxiliares são práticos para os usuários mongosh, mas podem não retornar o mesmo nível de informações que os comandos do banco de dados. Nos casos em que a praticidade não for necessária ou os campos de retorno adicionais forem necessários, use o comando de banco de dados.

Uma atualização em um campo substitui completamente os valores do campo anterior. Para conceder ou remover roles ou privilégios sem substituir todos os valores, use um ou mais dos seguintes comandos:

• grantRolesToRole

• grantPrivilegesToRole

• revokeRolesFromRole

• revokePrivilegesFromRole

Aviso

Uma atualização na array privileges ou roles substitui completamente os valores da matriz anterior.

Compatibilidade

Esse comando está disponível em implantações hospedadas nos seguintes ambientes:

• MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

• MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

• MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

Para atualizar um role, você deve fornecer o array privileges , o array roles ou ambos.

O comando usa a seguinte sintaxe:

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 comando

O comando utiliza os seguintes campos:

"readWrite"

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

Comportamento

Os privilégios de uma função se aplicam ao banco de dados em que a função é criada. A função pode herdar privilégios de outras funções em seu banco de dados. Uma função criada no banco de dados admin pode incluir privilégios que se aplicam a todos os bancos de dados ou ao cluster e pode herdar privilégios de funções em outros bancos de dados.

Acesso necessário

Você deve ter a ação revokeRole em todos os bancos de dados para atualizar uma role.

Você deve ter a ação grantRole no banco de dados de cada role no array roles para atualizar o array.

Você deve ter a ação grantRole no banco de dados de cada privilégio no array privileges para atualizar o array. Se o recurso de um privilégio abrange bancos de dados, você deverá ter grantRole no banco de dados admin. Um privilégio abrange bancos de dados se o privilégio for qualquer um dos seguintes:

• uma collection em todos os bancos de dados

• todas as collections e todos os bancos de dados

• o recurso cluster

Você deve ter a ação setAuthenticationRestriction no banco de dados da role de destino para atualizar o documento authenticationRestrictions de uma role.

Exemplo

A seguir está um exemplo do comando updateRole que atualiza a função myClusterwideAdmin no banco de dados admin . Embora as arrays privileges e roles sejam opcionais, pelo menos uma das duas é necessária:

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

Para visualizar os privilégios de uma role, utilize o comando rolesInfo.