db.getUser() (método mongosh)

Definición

db.getUser(username, args)

Returns user information for a specified user. Run this method on the user's database. If the user doesn't exist in the database, db.getUser() returns null.

The db.getUser() method has the following parameters:

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

Parameter	Tipo	Descripción
`username`	string	El nombre de usuario para el cual recuperar información.
`args`	Documento	opcional. Un documento que especifica argumentos adicionales.

El documento args admite los siguientes campos:

Campo	Tipo	Descripción
`showCredentials`	booleano	opcional. Configura en `true` para mostrar la contraseña encriptada del usuario. Por defecto, este campo es `false`.
`showCustomData`	booleano	opcional. Configúralo en `false` para omitir el `customData` del usuario en la salida. Por defecto, este campo es `true`. Nuevo en la versión 5.2.
`showPrivileges`	booleano	opcional. Configúralo en `true` para mostrar el conjunto completo de privilegios del usuario, incluyendo información ampliada sobre los roles heredados. Por defecto, este campo es `false`. Si ves todos los usuarios, no puedes especificar este campo.
`showAuthenticationRestrictions`	booleano	opcional. Establece en `true` para mostrar las restricciones de autenticación del usuario. Por defecto, este campo es `false`. Si ves todos los usuarios, no puedes especificar este campo.
`filter`	Documento	opcional. Un documento que especifica `$match` las condiciones para devolver información sobre los usuarios que cumplan con las condiciones del filtro.

db.getUser() wraps the usersInfo: <username> command.

Para detalles sobre la producción, vea usersInfo.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

Importante

Este comando no es compatible con los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulta Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Acceso requerido

Para ver la información de otro usuario, debe tener la acción viewUser en la base de datos de otro usuario.

Los usuarios pueden ver su propia información.

Ejemplos

Las siguientes operaciones devuelven información sobre un usuario de ejemplo appClient en una base de datos accounts:

use accounts
db.getUser("appClient")

Ejemplo de salida:

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

Omitir datos personalizados de la salida

New in version 5.2:

To omit a user's custom data from the db.getUser() output, set the showCustomData option to false.

Utilizar el comando createUser para crear un usuario denominado accountAdmin01 en la base de datos products:

db.getSiblingDB("products").runCommand( {
   createUser: "accountAdmin01",
   pwd: passwordPrompt(),
   customData: { employeeId: 12345 },
   roles: [ { role: 'readWrite', db: 'products' } ]
} )

El usuario contiene un campo customData de { employeeId: 12345 }.

To retrieve the user but omit the custom data from the output, run db.getUser() with showCustomData set to false:

db.getSiblingDB("products").getUser(
   "accountAdmin01",
   { showCustomData: false }
)

Ejemplo de salida:

{
   _id: 'products.accountAdmin01',
   userId: UUID("0955afc1-303c-4683-a029-8e17dd5501f4"),
   user: 'accountAdmin01',
   db: 'products',
   roles: [ { role: 'readWrite', db: 'products' } ],
   mechanisms: [ 'SCRAM-SHA-1', 'SCRAM-SHA-256' ]
}

Volver

db.dropAllUsers

db.getUsers