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


On this page


db.auth(username, password)

Allows a user to authenticate to the database from within the shell.

Parameter Type Description
username string Specifies an existing username with access privileges for this database.
password string Specifies the corresponding password.

Alternatively, you can use mongo --username and --password to specify authentication credentials.


The mongo shell excludes all db.auth() operations from the saved history.

Returns:db.auth() returns 0 when authentication is not successful, and 1 when the operation is successful.