db.createRole()

Definição

db.createRole(role, writeConcern)

Cria um papel em um banco de dados. Você pode especificar privilégios para o papel listando explicitamente os privilégios ou tendo o papel herdando privilégios de outros papéis ou ambos. O papel se aplica ao banco de dados no qual você executa o método.

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 createRole.

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

O método db.createRole() aceita os seguintes argumentos:

Parâmetro	Tipo	Descrição
role	documento	Um documento contendo o nome da função e a definição da função.
writeConcern	documento	Opcional. O nível da write concern para a operação. Consulte Especificação de write concern.

O documento role tem o seguinte formulário:

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

O documento role tem os seguintes campos:

Campo	Tipo	Descrição
role	string	O nome do novo role.
privileges	array	Os privilégios para conceder o role. Um privilégio consiste em um recurso e ações permitidas. Para a sintaxe de um privilégio, consulte a array privileges. Você deve incluir o campo privileges. Use uma array vazia para não especificar nenhum privilégio.
roles	array	Uma série de roles a partir dos quais este role herda privilégios. Você deve incluir o campo roles. Use uma array vazia para especificar nenhum role para herdar.
authenticationRestrictions	array	Opcional. As restrições de autenticação que o servidor impõe ao role. Especifica uma lista de endereços IP e os usuários do CIDR têm permissão para se conectar e/ou a partir da qual podem se conectar. Novidade na versão 3.6.

"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 role em um banco de dados, você deve ter:

• a createRole ação nesse recurso de banco de dados.

• A ação grantRole nesse banco de dados para especificar privilégios para o novo role, bem como para especificar roles dos quais herdar.

Roles integrados userAdmin e userAdminAnyDatabase fornecem ações createRole e grantRole em seus respectivos recursos.

Para criar um role com authenticationRestrictions especificado, você deve ter a ação setAuthenticationRestriction no recurso do banco de dados em que o role é criado.

Exemplo

O método db.createRole() a seguir cria a função myClusterwideAdmin no banco de dados admin:

use admin
db.createRole(
   {
     role: "myClusterwideAdmin",
     privileges: [
       { resource: { cluster: true }, actions: [ "addShard" ] },
       { resource: { db: "config", collection: "" }, actions: [ "find", "update", "insert", "remove" ] },
       { resource: { db: "users", collection: "usersCollection" }, actions: [ "update", "insert", "remove" ] },
       { resource: { db: "", collection: "" }, actions: [ "find" ] }
     ],
     roles: [
       { role: "read", db: "admin" }
     ]
   },
   { w: "majority" , wtimeout: 5000 }
)