Docs Menu
Docs Home
BI Connector

C Authentication Plugin

On this page

  • Supported Platforms
  • Installing the Plugin
  • Using the Plugin for Authentication

The MongoDB authentication plugin is embedded in the MongoDB BI Connector ODBC Driver. If your BI tool connects using the MongoDB BI Connector ODBC Driver through a DSN or the driver directly, you do not need to install the authentication plugin separately. Install the standalone authentication plugin if your BI tool does not use an ODBC driver and accepts authentication plugins, such the MySQL shell.

The mongosql_auth plugin allows a client to authenticate with a BI Connector and MongoDB deployment running with authentication enabled using one of the following authentication mechanisms:


  • SCRAM-SHA-256


  • GSSAPI (Kerberos)


  • The SCRAM-SHA-1 and SCRAM-SHA-256 mechanisms hash the passwords in the client plugin; however, all other data is in cleartext. If possible, use with encrypted connections.

  • The PLAIN mechanism sends the password in cleartext. Use encrypted connections with the PLAIN mechanism .

The plugin is built and tested on the following platforms:

  • Windows 2008 R2 (32- and 64-bit)

  • macOS 10.12 (64-bit)

  • Ubuntu 14.04 (64-bit)

  • RHEL 7.0 (64-bit)


Testing Environment

The C Authentication plugin was developed against MySQL 5.7.X Community Edition (64-bit), and tested with MySQL 5.7.X Community Edition and the latest version of MongoDB Connector for BI. The plugin is not compatible with MySQL Server or Connector/ODBC driver version 8 and later.

Before you use the authentication plugin, you must set up authenticated users for MongoDB. For more information on creating authenticated users, see Enable Authentication. If you are using the Atlas-hosted BI Connector, see Configure Database Users.

The procedure for using the C Authentication plugin library varies depending on your SQL client. The C Authentication plugin can be used via one of the following methods:

This plugin can is compatible with both the 32-bit or 64-bit versions of the MySQL shell and MySQL Connector/ODBC driver. The installation directory differs depending on the version you install.

← Authentication