db.auth（）

定义¶

db.auth（）¶

允许用户从外壳程序内对数据库进行身份验证。

小费

从mongoShell的4.2版本开始，您可以将该passwordPrompt()方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。但是，您仍然可以像在早期版本的mongoShell中一样直接指定密码 。

该db.auth()方法可以接受：

• 用户名和密码。

  复制

  db.auth( <username>, passwordPrompt() )
  
  // Or
  
  db.auth( <username>, <password> )
  

• 用户文档，其中包含用户名和密码，以及可选的身份验证机制和摘要密码标志。

  复制

  db.auth( {
     user: <username>,
     pwd: passwordPrompt(),   // Or "<cleartext password>"
     mechanism: <authentication mechanism>,
     digestPassword: <boolean>
  } )
  

参数	类型	描述
username	串	具有对此数据库的访问特权的用户名。
password	串	用户密码。该值可以是： 用户密码为明文字符串，或者 passwordPrompt() 提示输入用户密码。 小费 从mongoShell的4.2版本开始，您可以将该passwordPrompt()方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。但是，您仍然可以像在早期版本的mongoShell中一样直接指定密码 。
mechanism	串	可选的。要使用的身份验证机制。 有关可用的机制，请参阅认证机制。 如果未指定，则使用isMaster来确定指定用户的SASL机制。请参阅 saslSupportedMechs。
digestPassword	布尔值	可选的。确定在与指定的身份验证机制一起使用之前，是否应预先隐藏提供的密码。 对于SCRAM-SHA-1，尽管可以指定，但是true将该值设置为true不会提高安全性，并且可能会使用其他机制干扰凭据。 对于所有其他方法，此值必须设置为false （默认值）。任何其他值都将导致身份验证失败，因为这些方法无法理解MongoDB的预哈希。 默认值为false。

注意

在mongo外壳不包括所有db.auth()从已保存的历史操作。

返回值：	db.auth()返回0时，验证 未成功，1当操作成功。

行为¶

例子¶

要在连接mongo外壳后进行身份验证，请db.auth()在用户的身份验证数据库中发出 ：

use test
db.auth( "myTestDBUser", passwordPrompt() )

另外，您也可以使用mongoshell的命令行选项--username， --password， --authenticationDatabase，和--authenticationMechanism连接时指定认证凭证mongo壳：

mongo --username "myTestDBUser" --password --authenticationDatabase test --authenticationMechanism SCRAM-SHA-256