MongoDB Atlas

About the Device

MongoDB Atlas is a Database-as-a-Service that provides a high-performance that can store data of any structure. Customers can modify their schema at any time as they add new features to their applications to meet the rising demand for performance, reliability, and efficiency in every industry. With Mongo DB you get multi-cloud DB distribution so that customers can distribute their DB across all cloud regions on Amazon Web Services, MS Azure and Google Cloud.

Device Information

Collection Method

Device Configuration

To Grant Programmatic Access to a Project

You need to have ProjectOwner Access to provide below Access:

To Setup Auditing in MongoDB Atlas

1. Log in to your Atlas project.

2. In the Security section of the left navigation, click Advanced.

3. Toggle the button next to Database Auditing to On.

4. Confirm that you want to audit authentication failures.

5. In Select users and roles, select the database users, Atlas roles, and LDAP groups whose actions you want to audit.

6. In Select actions to audit, select the event actions that you want to audit.

7. Click Save.

To Create an API Key for a Project

1. Navigate to the Access Manager page for your organization.
   a) If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.

   b) Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.

2. Click Create API Key.

3. Enter the API Key Information.
   a) Enter a Description.

   b) In the Organization Permissions menu, select the new role or roles for the API key.

4. Click Next.

5. Copy and save the Public Key. The public key acts as the username when making API requests.

6. Copy and save the Private Key. The private key acts as the password when making API requests.

7. Add an API Access List Entry.
   a) Click Add Access list Entry.

   b) Enter an <LCP_IP> address or CIDR block from which you want Atlas to accept API requests for this API Key. You can also click Use Current IP Address if the host you are using to access Atlas will also make API requests using this API Key.
   c) Click Save.

8. Click Done. 

To Create an API Key in an Organization

1. Navigate to the Access Manager page for your organization.
   a) If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.

   b) Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.

2. Click Create API Key.

3. Enter the API Key Information.
   a) Enter a Description.

   b) In the Organization Permissions menu, select the new role or roles for the API key.

4. Click Next.

5. Copy and save the Public Key. The public key acts as the username when making API requests.

6. Copy and save the Private Key. The private key acts as the password when making API requests.

7. Add an API Access List Entry.
   a) Click Add Access list Entry.

   b) Enter an <LCP_IP> address from which you want Atlas to accept API requests for this API Key. You can also click Use Current IP Address if the host you are using to access Atlas will also make API requests using this API Key.
   c) Click Save.

8. Click Done.

To Invite an Organization API Key to a Project

1. Navigate to the Access Manager page for your project.
   a) If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   b) Select your desired project from the list of projects in the Projects page.
   c) Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
   d) Click Access Manager in the navigation bar, then click your project.

2. Click API Keys.

3. Add the API Key to the project.
   a) Click Invite to Project.

   b) Type the public key into the field.
   c) In the Project Permissions menu, select the new role or roles for the API key.

4. Click Invite to Project.

To Grant Role

1. Navigate to the Access Manager page for your project.
   a) If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   b) Select your desired project from the list of projects in the Projects page.
   c) Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
   d) Click Access Manager in the navigation bar, then click your project.

2. Click API Keys.

3. Add the API Key to the project.
   a) Click Invite to Project.

   b) Type the public key into the field.
   c) In the Project Permissions menu, select the new role or roles for the API key.

4. Click Invite to Project.

Integration Parameters

Parameters required from customer for Integration.