db.getUser() (método mongosh)

Definición

db.getUser(username, args)

Devuelve la información de un usuario especificado. Ejecute este método en la base de datos del usuario. Si el usuario no existe en la base de datos, db.getUser() nulldevuelve.

El método db.getUser() tiene los siguientes parámetros:

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` condiciones de etapa para devolver información de los usuarios que coinciden con las condiciones del filtro.

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

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

Novedad en la versión 5.2: para omitir los datos personalizados de un usuario de la salida db.getUser(), establece la opción showCustomData en false.

Utilice el comando para crear un usuario createUser llamado accountAdmin01 en la products base de datos:

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

Para recuperar el usuario pero omitir los datos personalizados de la salida, ejecute db.getUser() con showCustomData establecido en 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