MongoDB is the leading modern, general purpose database platform, designed to unleash the power of software and data for developers and the applications they build. Headquartered in New York, MongoDB has more than 22,600 customers in over 100 countries.

Authenticating

MongoDB uses API Key based auth, a developer-friendly delegated access protocol. Quolum has already connected the necessary wires with MongoDB. Using a sequence of click-throughs, your organization's administrator allows Quolum to make API calls to MongoDB without getting access to passwords.

Step 1: Initiate a connection to MongoDB

Click the Connect button from the Connections card. If you are not an admin, you can invite your organization's MongoDB admin to make a connection to your MongoDB organization account. When you click on the Connect button, the web browser will navigate to the MongoDB login page.

Step 2: Log in to MongoDB

Log in to MongoDB using your organization's credentials. The exact login mechanism may depend on your MongoDB plan, and the sign-in mechanism used. You may have corporate SSO such as Azure AD, GSuite, or Okta along with multi-factor authentication. Once you have successfully logged-in you can find the API Key and API Secret as mentioned below in Step 3.

Step 3: Step to find Public Key and Private Key

1. Log in to your MongoDB Atlas account: MongoDB Atlas is a cloud-based service that allows you to manage your MongoDB databases and clusters.
2. Navigate to the "Organizations" tab: Click on the "Organizations" tab.
3. Select the organization: Select the organization for which you want to create the API key.

4. Click on "Access Manager": Click on the "Access Manager" button in the left-hand navigation menu.

5. Click the "Create API Key" button: Click on the "Create API Key" button in the top right corner of the page.

6. Choose the API key settings: You can choose the name for the API key and set the access restrictions for the key. Make sure to include the "Organization Read Only" Permission as shown below.

7. Save the API key: After setting the API key settings, click the "Create" button to save the API key. You will be given the Public Key and the Private Key. Copy your private key and store it in a secure location. After you leave this page, the full private key is unavailable.

8. Use the API key in Quolum: You can use the Public key and Private API key to authenticate with MongoDB Atlas API for your organization.

Step 4: Back to Quolum

Once you have granted access to Quolum, MongoDB is going to send you back to Quolum's page in Step 1, where you started. The Connect button on the Connections card would now say Reconnect. Reconnect is used to reauthenticate under circumstances where the access has expired.

Under the hood

Using the OAuth protocol, Quolum now has delegated access to your MongoDB Workspace. The Quolum server, running on Amazon AWS VPC, will be able to make API calls and retrieve feature-level utilization. Later, this data is crunched and available for visualization on the Quolum dashboard.