rolesInfo

Definição

rolesInfo

Retorna informações de herança e privilégio para roles especificados, incluindo definidos pelo usuário e roles embutidos.

O comando rolesInfo também pode recuperar todos os papéis com escopo de um banco de dados de dados.

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

O comando tem a seguinte sintaxe:

db.runCommand(
   {
     rolesInfo: { role: <name>, db: <db> },
     showAuthenticationRestrictions: <Boolean>,
     showBuiltinRoles: <Boolean>,
     showPrivileges: <Boolean>,
     comment: <any>
   }
)

Campos de comando

O comando utiliza os seguintes campos:

Comportamento

{ rolesInfo: "<rolename>" }

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

{
  rolesInfo: [
     "<rolename>",
     { role: "<rolename>", db: "<database>" },
     ...
  ]
}

{ rolesInfo: 1, showBuiltinRoles: true }

Acesso necessário

Para visualizar as informações de um role, você deve ter recebido explicitamente a função ou deve ter a viewRole ação no banco de dados do role.

Saída

rolesInfo.role

O nome da role.

rolesInfo.db

O banco de dados de dados no qual o papel é definido. Todo banco de dados de dados tem roles integrados. Um banco de dados de dados também pode ter funções definidas pelo usuário.

rolesInfo.isBuiltin

Um valor de true indica que o papel é um papel embutido. Um valor de false indica que o papel é um papel definido pelo usuário.

rolesInfo.roles

As roles que fornecem privilégios diretamente a esta role e os bancos de dados nos quais as roles são definidas.

rolesInfo.inheritedRoles

Todas as funções das quais esta herda privilégios. Isso inclui as roles na array rolesInfo.roles , bem como as roles das quais as roles na array rolesInfo.roles herdam privilégios. Todos os privilégios se aplicam à função atual. Os documentos neste campo listam as funções e os bancos de dados nos quais elas são definidas.

rolesInfo.privileges

Os privilégios especificados diretamente por esta role; ou seja, a array exclui privilégios herdados de outras roles. Por padrão, a saída não inclui o campo privileges . Para incluir o campo, especifique showPrivileges: true ao executar o comando rolesInfo .

Cada documento de privilégio especifica os recursos e as ações permitidas nos recursos.

rolesInfo.inheritedPrivileges

Todos os privilégios concedidos por esta role, incluindo os herdados de outras roles. Por padrão, a saída não inclui o campo inheritedPrivileges . Para incluir o campo, especifique showPrivileges: true ao executar o comando rolesInfo .

Cada documento de privilégio especifica os recursos e as ações permitidas nos recursos.

Exemplos

Os exemplos nesta seção mostram como utilizar o comando rolesInfo para:

• Visualizar informações para uma única função

• Visualizar informações para várias funções

• Ver todas as funções definidas pelo usuário para um banco de dados

• Visualizar todas as funções definidas pelo usuário e integradas para um banco de dados

• Visualizar restrições de autenticação para roles

db.runCommand(
    {
      rolesInfo: { role: "associate", db: "products" }
    }
)

db.runCommand(
    {
      rolesInfo: "siteManager"
    }
)

db.runCommand(
    {
      rolesInfo: { role: "associate", db: "products" },
      showPrivileges: true
    }
)

db.runCommand(
    {
      rolesInfo: [
         { role: "associate", db: "products" },
         { role: "manager", db: "resources" }
      ]
    }
)

db.runCommand(
    {
      rolesInfo: [
         { role: "associate", db: "products" },
         { role: "manager", db: "resources" }
      ],
      showPrivileges: true
    }
)

db.runCommand(
    {
      rolesInfo: 1,
      showPrivileges: true
    }
)

{
  roles: [
    {
      _id: 'products.associate',
      role: 'associate',
      db: 'products',
      privileges: [
        {
          resource: { db: 'products', collection: '' },
          actions: [ 'bypassDocumentValidation' ]
        }
      ],
      roles: [ { role: 'readWrite', db: 'products' } ],
      isBuiltin: false,
      inheritedRoles: [ { role: 'readWrite', db: 'products' } ],
      inheritedPrivileges: [
        {
          resource: { db: 'products', collection: '' },
          actions: [ 'bypassDocumentValidation' ]
        },
        {
          resource: { db: 'products', collection: '' },
          actions: [
            'changeStream',
            'collStats',
            'compactStructuredEncryptionData',
            ...
          ]
        },
        ...
      ]
    }
  ],
  ok: 1
}

db.runCommand(
    {
      rolesInfo: 1,
      showBuiltinRoles: true
    }
)

{
  roles: [
    {
      role: 'enableSharding',
      db: 'products',
      isBuiltin: true,
      roles: [],
      inheritedRoles: []
    },
    {
      role: 'userAdmin',
      db: 'products',
      isBuiltin: true,
      roles: [],
      inheritedRoles: []
    },
    {
      role: 'read',
      db: 'products',
      isBuiltin: true,
      roles: [],
      inheritedRoles: []
    },
    ...
  ],
  ok: 1
}

db.runCommand(
    {
      rolesInfo: 1,
      showAuthenticationRestrictions: true
    }
)

{
  roles: [
    {
      _id: 'products.associate',
      role: 'associate',
      db: 'products',
      roles: [ { role: 'readWrite', db: 'products' } ],
      authenticationRestrictions: [
        [ { clientSource: [ '198.51.100.0' ] } ]
      ],
      isBuiltin: false,
      inheritedRoles: [ { role: 'readWrite', db: 'products' } ],
      inheritedAuthenticationRestrictions: [
        [ { clientSource: [ '198.51.100.0' ] } ]
      ]
    }
  ],
  ok: 1
}