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

Authentication Plugins

The MongoDB Connector for BI offers authentication plugins allowing you to authenticate using either the SCRAM-SHA-1 or PLAIN authentication mechanisms. Install either the C or JDBC authentication plugin depending on which is compatible with your BI Tool:

Install the C Authentication Plugin
Instructions for installing the C Authentication Plugin, which facilitates authentication between the BI Connector and SQL clients such as Tableau and the MySQL shell.
Install the JDBC Authentication Plugin
Instructions for installing the JDBC Authentication Plugin.

For more information on connecting BI Tools to the BI Connector, see Connect BI Tools.


The use of TLS/SSL is recommended in addition to using an authentication plugin as:

  • The SCRAM-SHA-1 mechanism hashes the passwords in the client plugin. However, all other data is in cleartext.
  • The PLAIN mechanism sends the password in cleartext.

The MongoDB Connector for BI requires authentication when running with --auth. When the MongoDB Connector for BI receives a connection with authentication credentials from a client, it passes those credentials through to the underlying MongoDB instance.

Authentication Options

You can specify the following authentication options after your username as URI-style query parameters:

Connection Option Description

Specify the name of the database which stores the user’s credentials. If you do not specify this option, the MongoDB Connector for BI will default to the current database associated with the MySQL connection.

For authentication mechanisms such as PLAIN (LDAP) that delegate credential storage to other services, set the source value to $external.


Specify the mechanism that the MongoDB Connector for BI should use to authenticate the connection. Accepted values include:

LDAP requires MongoDB Enterprise. Set the source to $external when using LDAP.


Neither Kerberos nor x.509 are supported.


To authenticate as user grace with the LDAP authentication mechanism, use the following username: