db.getUsers() (método mongosh)

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 6.0, consulte Procedimientos de actualización de MongoDB.7.0

Definición

db.getUsers(<options>)

Devuelve información de todos los usuarios en la base de datos.

db.getUsers() envuelve el usersInfo: 1 dominio.

El método puede tomar las siguientes db.getUsers() opciones:

db.getUsers( {
   showCredentials: <Boolean>,
   showCustomData: <Boolean>,
   filter: <document>
} )

Campo	Tipo	Descripción
`showCredentials`	booleano	Opcional. Establezca en `true` para mostrar el hash de la contraseña del usuario. De forma predeterminada, este campo es `false`.
`showCustomData`	booleano	Opcional. Establezca en `false` para omitir el `customData` del usuario en la salida. De forma predeterminada, este campo es `true`. Nuevo en la versión 5.2.
`filter`	Documento	Opcional. Un documento que especifica las condiciones de la etapa para devolver información de los usuarios que coinciden con las condiciones del `$match` filtro.

Para obtener más información, consulta 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

Ver todos los usuarios de una base de datos que coinciden con el filtro especificado

El método puede aceptar db.getUsers() un filter documento para devolver información de los usuarios que coinciden con la condición de filtro.

Para ver todos los usuarios de la base de datos actual que tienen credenciales SCRAM-SHA-256:

db.getUsers({ filter: { mechanisms: "SCRAM-SHA-256" } })

Al ver todos los usuarios, puede especificar la opción showCredentials pero no las opciones showPrivileges o showAuthenticationRestrictions.

Omitir datos personalizados de la salida

Nuevo en la 5.2 versión: Para omitir los datos personalizados de los usuarios de la salida, configure db.getUsers() la showCustomData opción false en.

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.getUsers() con showCustomData establecido false en:

db.getSiblingDB("products").getUsers( { showCustomData: false } )

Ejemplo de salida:

{
   users: [
     {
       _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' ]
     }
   ],
   ok: 1
}

Volver

db.getUser

db.grantRolesToUser