Skip to main content

Authenticate to MongoDB

After you add the connector, you need to set the required properties.
  • Server: Enter the name or address of the server on which your MongoDB instance runs. The default server is localhost.
  • Port: Enter the port for the MongoDB database. The default port value is 27017.
supports authenticating to MongoDB in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

MongoDB Challenge Response

To connect with a MongoDB challenge response (CR), specify the following properties:
  • Auth Scheme: Select MongoDB-CR.
  • User: Enter the username that you use to authenticate to the MongoDB account.
  • Password: Enter the password that you use to authenticate to the MongoDB account.

SCRAM SHA-1

To connect with the SCRAM SHA-1 credentials, specify these properties:
  • Auth Scheme: Select SCRAM-SHA-1.
  • User: Enter the username that you use to authenticate to the MongoDB account.
  • Password: Enter the password that you use to authenticate to the MongoDB account.

SCRAM SHA-256

To connect with the SCRAM SHA-256 credentials, specify these properties:
  • Auth Scheme: Select SCRAM-SHA-256.
  • User: Enter the username that you use to authenticate to the MongoDB account.
  • Password: Enter the password that you use to authenticate to the MongoDB account.

Plain

Generic Security Services API

To connect with Kerberos credentials, specify these properties:
  • Auth Scheme: Select GSSAPI.
  • Kerberos KDC: Enter the this to the host name or IP Address of your Kerberos Key Distribution Center (KDC) machine.
  • Kerberos Realm: Enter the Kerberos realm that you use to authenticate to Kerberos.
  • Kerberos SPN: Enter the service principal name (SPN) for the Kerberos domain controller.
  • Kerberos User: Enter the principal name for the Kerberos domain controller. They syntax for this name is Host/User@realm.
  • (Optional) Kerberos Keytab File: Enter the full file path to your Kerberos keytab file.
  • (Optional) Kerberos Ticket Cache: Enter the full file path to an MIT Kerberos credential cache file.

X.509 Certificate

To connect with X.509 certificate authentication, specify these properties:
  • **Auth Scheme:**Select X509.
  • User: Enter the username that you use to authenticate to the MongoDB account.
  • Password: Enter the password that you use to authenticate to the MongoDB account.

None

Complete Your Connection

To complete your connection:
  1. Specify the following properties:
    • (Optional) Database: Enter the name of the MongoDB database that you want to read from and write to. Note: To connect to data from one database and authenticate to another database, you need to set both Database and Auth Database.
    • (Optional) Auth Database: Enter the name of the MongoDB database that you want to use for authentication. (See note above for when to specify this property.) Note: If you want to use LDAP authentication, set Auth Database to $external and set AuthScheme to PLAIN. This Auth Scheme value specifies the SASL PLAIN mechanism. This mechanism transmits credentials over plaintext, so it is not suitable for use without TLS/SSL on untrusted networks.
    • (Optional) Replica Set: Enter a comma-separated list of secondary servers in the replica set, specified by address and port. Example: ServerURL_1:27017,ServerURL_2:27017
    • (Optional) DNS Server: Enter the hostname of a domain name system (DNS) server that can resolve the necessary DNS entries.
    • Use SSL: Select whether you want to enable Secure Sockets Layer (SSL). By default, the Enable checkbox is not selected.
  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.) Note: To ensure that the UPSERT command runs correctly when you use MongoDB as a destination, you must configure the following properties in the Miscellaneous section of the tab:
    • Data Model: Select DOCUMENT.
    • Flatten Arrays: Enter a value of 0.
    • Flatten Objects: Select False.
    In your job configuration, you also need to map the MongoDB _id field as the primary key for your source table. These settings are required because MongoDB upserts only work with unflattened documents. Flattening arrays or objects changes the structure into multiple records, which prevents MongoDB from matching rows for update. Mapping the primary key to the _id column ensures that can correctly identify and update existing documents instead of inserting duplicates.
  3. Click Create & Test to create your connection.