MongoDB X.509 Client Authentication

Last updated: 3 minutes read.

You can use the MongoDB X509 Certificate flow to authenticate the Tyk Dashboard, Tyk Pump, and Tyk MDCB with your MongoDB install. This is slightly different from AWS DocumentDB setup instructions.

Setting Up

Before we get into the configuration, we need to understand the two key components: connection strings and certificates.

1. Connection Strings

  1. You must specify a username (and password if needed) in the connection string. Why do you need a username at all?

  2. We must specify the following parameters: ?authSource=$external&authMechanism=MONGODB-X509"

An example of a connection string would be:


If you have to include a password, you can do it after the username in basic auth format:

URL Encoding Protected Characters

Note that you must URL encode the : character into %40. So replace any : in the username field into the URL encoded version.

2. Certificates

You’ll need to provide two certificates to complete the X509 Client Authentication:

CA Cert containing just the public key of the Certificate Authority (CA).

Client Cert containing both the public and private keys of the client.


Here’s what it looks like all put together:

Tyk Dashboard

Your tyk_analytics.conf should include these fields at the root level:

  "mongo_url": "mongodb://<username>@<host>:<port>/<db>?authSource=$external&authMechanism=MONGODB-X509",
  "mongo_use_ssl": true,
  "mongo_ssl_ca_file": "ca.pem",
  "mongo_ssl_pem_keyfile": "client.pem"
Config File Environment Variable Type Examples
“mongo_url” TYK_DB_MONGOURL string “mongodb://{username}@{host}:{port}/{db}?authSource=$external&authMechanism=MONGODB-X509”
“mongo_use_ssl” TYK_DB_MONGOUSESSL bool true, false
“mongo_ssl_ca_file” TYK_DB_MONGOSSLCAFILE string “certificates/ca.pem”
“mongo_ssl_pem_keyfile” TYK_DB_MONGOSSLPEMKEYFILE string “certificates/key.pem”
“mongo_ssl_insecure_skip_verify” TYK_DB_MONGOSSLINSECURESKIPVERIFY bool true, false
“mongo_ssl_allow_invalid_hostnames” TYK_DB_MONGOSSLALLOWINVALIDHOSTNAMES bool true, false
“mongo_session_consistency” TYK_DB_MONGOSESSIONCONSISTENCY string “strong”, “eventual”, or “monotonic”. default is “strong”
“mongo_batch_size” TYK_DB_MONGOBATCHSIZE int Default “2000”, min “100”

Tyk Pump

Tyk offers three different MongoDB pumps (mongo, mongo_aggregate, and mongo_selective), each of which must be separately configured for X509 certificate authentication.

The following fields must be set under the meta section of each pump (or set as environment variable):

  "pumps": {
    "mongo": {
      "type": "mongo",
      "meta": {
        "collection_name": "tyk_analytics",
        "mongo_url": "mongodb://CN=tyk-mongo-client,OU=TykTest@<host>:<port>/<db>?authSource=$external&authMechanism=MONGODB-X509",
        "mongo_use_ssl": true,
        "mongo_ssl_ca_file": "ca.pem",
        "mongo_ssl_pem_keyfile": "client.pem"

In addition to the other configs, these are the ones related to MongoDB:

Config File Type Examples
“mongo_url” string “mongodb://{username}@{host}:{port}/{db}?authSource=$external&authMechanism=MONGODB-X509”
“mongo_use_ssl” bool true, false
“mongo_ssl_ca_file” string “certificates/ca.pem”
“mongo_ssl_pem_keyfile" string “certificates/key.pem”
“mongo_ssl_insecure_skip_verify” bool true, false
“mongo_ssl_allow_invalid_hostnames” bool true, false


As of Tyk MDCB v1.8.0, you have been able to secure Tyk MDCB with MongoDB using X509 Certificate Authentication flow.

The config settings are exactly the same as the Tyk Dashboard steps, just nested one level deeper:

Example Config:

  "analytics": {
    "mongo_url": "mongodb://CN=tyk-mongo-client,OU=TykTest@<host>:<port>/<db>?authSource=$external&authMechanism=MONGODB-X509",
    "mongo_use_ssl": true,
    "mongo_ssl_ca_file": "ca.pem",
      "mongo_ssl_pem_keyfile": "client.pem"
Config File Environment Variable Type Examples
“analytics.mongo_url” TYK_MDCB_ANALYTICSCONFIG_MONGOURL string “mongodb://{username}@{host}:{port}/{db}?authSource=$external&authMechanism=MONGODB-X509”
“analytics.mongo_use_ssl” TYK_MDCB_ANALYTICSCONFIG_MONGOUSESSL bool true, false
“analytics.mongo_ssl_ca_file” TYK_MDCB_ANALYTICSCONFIG_MONGOSSLCAFILE string “certificates/ca.pem”
“analytics.mongo_ssl_pem_keyfile” TYK_MDCB_ANALYTICSCONFIG_MONGOSSLPEMKEYFILE string “certificates/key.pem”
“analytics.mongo_ssl_insecure_skip_verify” TYK_MDCB_ANALYTICSCONFIG_MONGOSSLINSECURESKIPVERIFY bool true, false
“analytics.mongo_ssl_allow_invalid_hostnames” TYK_MDCB_ANALYTICSCONFIG_MONGOSSLALLOWINVALIDHOSTNAMES bool true, false
“analytics.mongo_session_consistency” TYK_MDCB_ANALYTICSCONFIG_MONGOSESSIONCONSISTENCY string “strong”, “eventual”, or “monotonic”. default is “strong”
“analytics.mongo_batch_size” TYK_MDCB_ANALYTICSCONFIG_MONGOBATCHSIZE int Default “2000”, min “100”