db.updateUser() (método mongosh)

Definição

db.updateUser( username, update, writeConcern )

Atualiza o perfil do usuário no banco de dados no qual você executa o método. Uma atualização em um campo substitui completamente os valores do campo anterior. Isso inclui atualizações na array roles do usuário.

Aviso

Ao atualizar a matriz roles , você substitui completamente os valores da matriz anterior. Para adicionar ou remover funções sem substituir todas as funções existentes do usuário, utilize os métodos db.grantRolesToUser() ou db.revokeRolesFromUser().

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

Dica

Você pode usar o método passwordPrompt() em conjunto com vários métodos e comandos de gerenciamento de autenticação de usuário para solicitar a senha em vez de especificar a senha diretamente na chamada de método ou comando. No entanto, você ainda pode especificar a senha diretamente como faria com versões anteriores do shell mongo.

db.updateUser(
   "<username>",
   {
     customData : { <any information> },
     roles : [
       { role: "<role>", db: "<database>" } | "<role>",
       ...
     ],
     pwd: passwordPrompt(),      // Or  "<cleartext password>"
     authenticationRestrictions: [
        {
          clientSource: ["<IP>" | "<CIDR range>", ...],
          serverAddress: ["<IP>", | "<CIDR range>", ...]
        },
        ...
     ],
     mechanisms: [ "<SCRAM-SHA-1|SCRAM-SHA-256>", ... ],
     passwordDigestor: "<server|client>"
   },
   writeConcern: { <write concern> }
)

The db.updateUser() method has the following arguments.

Parâmetro	Tipo	Descrição
username	string	O nome do usuário a ser atualizado.
update	documento	Um documento contendo os dados de substituição para o usuário. Esses dados substituem completamente os dados correspondentes para o usuário.
writeConcern	documento	Opcional. O nível da write concern para a operação. Consulte Especificação de write concern.

O documento update especifica os campos para atualizar e seus novos valores. Todos os campos no documento update são opcionais, mas deve incluir pelo menos um campo.

O documento update tem os seguintes campos:

Campo	Tipo	Descrição
customData	documento	Opcional. Qualquer informação arbitrária.
roles	array	Opcional. As funções concedidas ao usuário. Uma atualização na array roles substitui os valores da array anterior.
pwd	string	Opcional. A senha do usuário. O valor pode ser: a senha do usuário em string de texto não criptografado ou passwordPrompt() para solicitar a senha do usuário. Você pode usar o método passwordPrompt() em conjunto com vários métodos e comandos de gerenciamento de autenticação de usuário para solicitar a senha em vez de especificar a senha diretamente na chamada de método ou comando. No entanto, você ainda pode especificar a senha diretamente como faria com versões anteriores do shell mongo.
authenticationRestrictions	array	Opcional. As restrições de autenticação que o servidor impõe ao usuário. Especifica uma lista de endereços IP e faixas CIDR a partir das quais o usuário tem permissão para se conectar ao servidor ou a partir das quais o servidor pode aceitar usuários.
mechanisms	array	Opcional. O mecanismo ou mecanismos SCRAM específicos para as credenciais do usuário. Se authenticationMechanisms for especificado, você só poderá especificar um subconjunto de authenticationMechanisms. Se atualizar o campo de mecanismos sem a senha, você só poderá especificar um subconjunto dos mecanismos atuais do usuário, e somente as credenciais de usuário existentes para o mecanismo ou mecanismos especificados serão mantidas. Se atualizar a senha junto com os mecanismos, o novo conjunto de credenciais será armazenado para o usuário. Os valores válidos são: "SCRAM-SHA-1" Utiliza a função de hash SHA-1. "SCRAM-SHA-256" Utiliza a função de hash SHA-256. Exige featureCompatibilityVersion definido para 4.0. Requer que o passwordDigestor seja server.
passwordDigestor	string	Opcional. Indica se o servidor ou o cliente digere a senha. Os valores disponíveis são: "server" (Padrão) O servidor recebe senha não digerida do cliente e digere a senha. "client" (Não compatível com SCRAM-SHA-256) O cliente digere a senha e passa a senha digerida para o servidor.

"readWrite"

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

Compatibilidade

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

• 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

Comportamento

Acesso necessário

Você deve ter acesso que inclua a revokeRole ação em todos os bancos de dados para atualizar a array roles de um usuário.

É necessário ter a grantRole ação no banco de dados de uma função para adicionar uma função a um usuário.

Para alterar o campo pwd ou de outro customData usuário, é necessário ter as changePassword ações changeCustomData e, respectivamente, no banco de dados desse usuário.

Para modificar sua própria senha e dados personalizados, você deve ter privilégios que concedam changeOwnPassword e changeOwnCustomData ações respectivamente no banco de dados do usuário.

Exemplo

Dado um usuário appClient01 no banco de dados do products com as seguintes informações de usuário:

{
   _id : "products.appClient01",
   userId : UUID("c5d88855-3f1e-46cb-9c8b-269bef957986"),
   user : "appClient01",
   db : "products",
   customData : { empID : "12345", badge : "9156" },
   roles : [
       {
         role : "readWrite",
         db : "products"
       },
       {
         role : "read",
         db : "inventory"
       }
   ],
   mechanisms : [
      "SCRAM-SHA-1",
      "SCRAM-SHA-256"
   ],
   authenticationRestrictions : [ {
      clientSource: ["69.89.31.226"],
      serverAddress: ["172.16.254.1"]
   } ]
}

The following db.updateUser() method completely replaces the user's customData and roles data:

use products
db.updateUser( "appClient01",
{
   customData : { employeeId : "0x3039" },
   roles : [
      { role : "read", db : "assets"  }
   ]
} )

O usuário appClient01 no banco de dados do products agora tem as seguintes informações de usuário:

{
   _id : "products.appClient01",
   userId : UUID("c5d88855-3f1e-46cb-9c8b-269bef957986"),
   user : "appClient01",
   db : "products",
   customData : { employeeId : "0x3039" },
   roles : [
       {
         role : "read",
         db : "assets"
       }
   ],
   mechanisms : [
      "SCRAM-SHA-1",
      "SCRAM-SHA-256"
   ],
   authenticationRestrictions : [ {
      clientSource: ["69.89.31.226"],
      serverAddress: ["172.16.254.1"]
   } ]
}

use reporting
db.updateUser(
   "reportUser256",
   {
     mechanisms: [ "SCRAM-SHA-256" ]
   }
)