db.getUser()

Definição

db.getUser(username, args)

Retorna informações do usuário para um usuário especificado. Execute este método no banco de banco de dados do usuário. Se o usuário não existir no banco de banco de dados, db.getUser() retornará null.

O método db.getUser() tem os seguintes parâmetros:

db.getUser( "<username>", {
   showCredentials: <Boolean>,
   showPrivileges: <Boolean>,
   showAuthenticationRestrictions: <Boolean>,
   filter: <document>
} )

Parâmetro	Tipo	Descrição
username	string	O nome do usuário para o qual recuperar as informações.
args	documento	Opcional. Um documento que especifica argumentos adicionais.

O documento args aceita os seguintes campos:

Campo	Tipo	Descrição
showCredentials	booleano	Opcional. Defina o campo como verdadeiro para exibir o hash da senha do usuário. Por padrão, este campo é false.
showPrivileges	booleano	Opcional. Defina o campo como verdadeiro para mostrar o conjunto completo de privilégios do usuário, incluindo informações expandidas para as funções herdadas. Por padrão, este campo é false. Se estiver visualizando todos os usuários, você não poderá especificar este campo.
showAuthenticationRestrictions	booleano	Opcional. Configure o campo para verdadeiro para mostrar as restrições de autenticação do usuário. Por padrão, este campo é false. Se estiver visualizando todos os usuários, você não poderá especificar este campo.
filter	documento	Opcional. Um documento que especifica condições de estágio $match para retornar informações para usuários que correspondem às condições de filtro.

db.getUser() encapsula o comando usersInfo: <username>.

Para detalhes sobre saída, consulte usersInfo.

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 outro usuário, você deve ter a viewUser ação no banco de dados do outro usuário.

Os usuários podem ver suas próprias informações.

Exemplo

As operações a seguir retornam informações sobre um usuário appClient de exemplo em um banco de dados accounts:

use accounts
db.getUser("appClient")

Saída de exemplo:

{
   _id: 'accounts.appClient',
   userId: UUID("1c2fc1bf-c4dc-4a22-8b04-3971349ce0dc"),
   user: 'appClient',
   db: 'accounts',
   roles: [],
   mechanisms: [ 'SCRAM-SHA-1', 'SCRAM-SHA-256' ]
}