- Reference >
mongo
Shell Methods >- User Management Methods >
- db.auth()
db.auth()¶
On this page
Definition¶
-
db.
auth
()¶ Allows a user to authenticate to the database from within the shell.
The
db.auth()
method can accept either:the username and password.
a user document that contains the username and password, and optionally, the authentication mechanism and a digest password flag.
Parameter Type Description username
string Specifies an existing username with access privileges for this database. password
string Specifies the corresponding password. mechanism
string Optional. Specifies the authentication mechanism to use.
For available mechanisms, see authentication mechanisms.
If unspecified, uses the
isMaster
to determine the SASL mechanism or mechanisms for the specified user. SeesaslSupportedMechs
.digestPassword
boolean Optional. Determines whether or not the supplied password should be pre-hashed before being used with the specified authentication mechanism.
- For SCRAM-SHA-1, although you may
specify
true
, setting this value totrue
does not improve security and may interfere with credentials using other mechanisms. - For all other methods, this value must be set to
false
(default value). Any other value will result in authentication failure since those methods do not understand MongoDB pre-hashing.
The default value is
false
.Alternatively, you can use
mongo --username
,--password
,--authenticationDatabase
, and--authenticationMechanism
to specify authentication credentials.Returns: db.auth()
returns0
when authentication is not successful, and1
when the operation is successful.