db.auth()¶

Definition¶

db.auth(username, password)¶

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

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

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

--authenticationMechanism supports additional mechanisms not available when using db.auth().

Note

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.

← db.addUser() db.changeUserPassword() →