db.createUser()

Definição

db.createUser(user, writeConcern)

Cria um novo usuário para o banco de dados no qual o método é executado. db.createUser() retorna um erro de usuário duplicado se o usuário já existir no banco de dados.

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação para comandos de banco de dados nem drivers específicos de linguagem, como Node.js.

Para o comando de banco de dados de dados, consulte o comando createUser.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

O método db.createUser() tem a seguinte sintaxe:

Campo	Tipo	Descrição
user	documento	O documento com autenticação e informações de acesso sobre o usuário a ser criado.
writeConcern	documento	Opcional. O nível da write concern para a operação. Consulte Especificação de write concern.

O documento user define o usuário e tem o seguinte formulário:

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.

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

O documento user tem os seguintes campos:

Campo	Tipo	Descrição
user	string	O nome do novo usuário.
pwd	string	A senha do usuário. O campo pwd não será exigido se você executar o db.createUser() no banco de dados do $external para criar usuários com credenciais armazenadas externamente no MongoDB. 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.
customData	documento	Opcional. Qualquer informação arbitrária. Este campo pode ser usado para armazenar quaisquer dados que um administrador deseja associar a este usuário específico. Por exemplo, este pode ser o nome completo do usuário ou ID do funcionário.
roles	array	As funções concedidas ao usuário. Pode especificar uma array vazia [] para criar usuários sem papéis.
restrições de autenticação	array	Opcional. As restrições de autenticação que o servidor impõe ao usuário criado. Especifica uma lista de endereços IP e intervalos CIDR a partir dos quais o usuário tem permissão para se conectar ao servidor ou a partir dos quais o servidor pode aceitar usuários.
mechanisms	array	Opcional. Especifique o mecanismo ou mecanismos específicos do SCRAM para criar credenciais de usuário do SCRAM. Se authenticationMechanisms for especificado, você só poderá especificar um subconjunto do authenticationMechanisms. 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. Requer que o passwordDigestor seja server. O padrão é SCRAM-SHA-1 e SCRAM-SHA-256.
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

• Para criar um novo usuário em um banco de dados, você deve ter a createUser ação neste recurso do banco de dados.

• Para conceder funções a um usuário, você deve ter a açãograntRole no banco de dados da função.

Os papéis embutidos do userAdmin e userAdminAnyDatabase fornecem ações do createUser e grantRole em seus respectivos recursos.

Exemplos

A operação db.createUser() a seguir cria o usuário accountAdmin01 no banco de dados products.

use products
db.createUser( { user: "accountAdmin01",
                 pwd: passwordPrompt(),  // Or  "<cleartext password>"
                 customData: { employeeId: 12345 },
                 roles: [ { role: "clusterAdmin", db: "admin" },
                          { role: "readAnyDatabase", db: "admin" },
                          "readWrite"] },
               { w: "majority" , wtimeout: 5000 } )

A operação fornece a accountAdmin01 as seguintes funções:

• as funções clusterAdmin e readAnyDatabase no banco de dados admin

• a função readWrite no banco de dados products

use products
db.createUser(
   {
     user: "accountUser",
     pwd: passwordPrompt(),  // Or  "<cleartext password>"
     roles: [ "readWrite", "dbAdmin" ]
   }
)

use admin
db.createUser(
   {
     user: "reportsUser",
     pwd: passwordPrompt(),  // Or  "<cleartext password>"
     roles: [ ]
   }
)

use admin
db.createUser(
   {
     user: "appAdmin",
     pwd: passwordPrompt(),   // Or  "<cleartext password>"
     roles:
       [
         { role: "readWrite", db: "config" },
         "clusterAdmin"
       ]
   }
)

use admin
db.createUser(
   {
     user: "restricted",
     pwd: passwordPrompt(),      // Or  "<cleartext password>"
     roles: [ { role: "readWrite", db: "reporting" } ],
     authenticationRestrictions: [ {
        clientSource: ["192.0.2.0"],
        serverAddress: ["198.51.100.0"]
     } ]
   }
)

use reporting
db.createUser(
   {
     user: "reportUser256",
     pwd: passwordPrompt(),   // Or  "<cleartext password>"
     roles: [ { role: "readWrite", db: "reporting" } ],
     mechanisms: [ "SCRAM-SHA-256" ]
   }
)