db.getRole() (método mongosh)

Definição

db.getRole(rolename, args)

Retorna as funções das quais essa role herda privilégios. Opcionalmente, o método também pode retornar todos os privilégios da role.

Run db.getRole() from the database that contains the role. The command can retrieve information for both user-defined roles and built-in roles.

The db.getRole() method accepts the following parameters:

Parâmetro	Tipo	Descrição
rolename	string	O nome da role.
args	documento	Opcional. Um documento que especifica argumentos adicionais.

O documento args suporta os seguintes campos opcionais:

Campo	Tipo	Descrição
showAuthenticationRestrictions	booleano	Opcional. Configure este campo como true para incluir restrições de autenticação na saída. As restrições de autenticação indicam os endereços IP aos quais os usuários com esta role podem se conectar. Por padrão, este campo é false, significando que a saída db.getRole() não inclui restrições de autenticação.
showBuiltinRoles	booleano	Opcional. Configure este campo como true para incluir roles incorporadas na saída. Por padrão, este campo é configurado como false, e a saída de rolesInfo: 1 exibe somente roles definidas pelo usuário.
showPrivileges	booleano	Opcional. Configure este campo como true para mostrar privilégios de role, incluindo ambos os privilégios herdados de outras roles e privilégios definidos diretamente. Por padrão, o comando retorna somente as roles das quais esta role herda privilégios e não retorna privilégios específicos.

db.getRole() wraps the rolesInfo command.

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

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.

Exemplos

Os exemplos nesta seção mostram como utilizar db.getRoles para:

• Mostrar informações de herança de role

• Mostrar privilégios de role

• Mostrar restrições de autenticação

use products
db.getRole( "associate" )

{
  _id: 'products.associate',
  role: 'associate',
  db: 'products',
  roles: [ { role: 'readWrite', db: 'products' } ],
  inheritedRoles: [ { role: 'readWrite', db: 'products' } ],
  isBuiltin: false
}

use products
db.getRole( "associate", { showPrivileges: true } )

{
  _id: 'products.associate',
  role: 'associate',
  db: 'products',
  privileges: [
    {
      resource: { db: 'products', collection: '' },
      actions: [ 'bypassDocumentValidation' ]
    }
  ],
  roles: [ { role: 'readWrite', db: 'products' } ],
  inheritedRoles: [ { role: 'readWrite', db: 'products' } ],
  inheritedPrivileges: [
    {
      resource: { db: 'products', collection: '' },
      actions: [ 'bypassDocumentValidation' ]
    },
    {
      resource: { db: 'products', collection: '' },
      actions: [
        'changeStream',
        'collStats',
        'compactStructuredEncryptionData',
        'convertToCapped',
        'createCollection',
        'createIndex',
        'dbHash',
        'dbStats',
        'dropCollection',
        'dropIndex',
        'find',
        'insert',
        'killCursors',
        'listCollections',
        'listIndexes',
        'planCacheRead',
        'remove',
        'renameCollectionSameDB',
        'update'
      ]
    }
  ],
  isBuiltin: false
}

use products
db.getRole( "associate", { showAuthenticationRestrictions: true } )

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