db.getUsers() (método mongosh)

Definición

db.getUsers(<options>)

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

db.getUsers() wraps the usersInfo: 1 command.

The db.getUsers() method can take the following options:

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

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.
`filter`	Documento	opcional. Un documento que especifica `$match` las condiciones para devolver información sobre los usuarios que cumplan con las condiciones del 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 coincidan con el filtro especificado

The db.getUsers() method can accept a filter document to return information for users that match the filter condition.

Para ver a 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, puedes especificar la opción showCredentials pero no las opciones showPrivileges o showAuthenticationRestrictions.

Omitir datos personalizados de la salida

New in version 5.2:

To omit users' custom data from the db.getUsers() 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.getUsers() with showCustomData set to false:

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