Navigation
This version of the documentation is archived and no longer supported.

db.getUser()

Definition

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>,
   showPrivileges: <Boolean>,
   showAuthenticationRestrictions: <Boolean>,
   filter: <document>
} )
Parameter Type Description
username string The name of the user for which to retrieve information.
args document Optional. A document specifying additional arguments.

The args document supports the following fields:

Field Type Description
showCredentials boolean Optional. Set the field to true to display the user’s password hash. By default, this field is false.
showPrivileges boolean Optional. Set the field to true to show the user’s full set of privileges, including expanded information for the inherited roles. By default, this field is false. If viewing all users, you cannot specify this field.
showAuthenticationRestrictions boolean Optional. Set the field to true to show the user’s authentication restrictions. By default, this field is false. If viewing all users, you cannot specify this field.
filter document Optional. A document that specifies $match stage conditions to return information for users that match the filter conditions.

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

For details on output, see usersInfo.

Required Access

To view another user’s information, you must have the viewUser action on the other user’s database.

Users can view their own information.

Example

The following sequence of operations returns information about the appClient user on the accounts database:

use accounts
db.getUser("appClient")