MongoDB
Visualize MongoDB users, projects, teams, API keys, clusters, and roles in the JupiterOne graph. Our guide provides step-by-step instructions on setting up the integration and utilizing its data model to gain visibility into your MongoDB Atlas environment.
- Installation guide
- MongoDB data model
Installation
To use this integration, JupiterOne requires an API public key and corresponding private key from MongoDB Atlas.
Configuration in MongoDB Atlas (UI)
In order to create an API Key, you must have Organization Owner access to Atlas.
Each API Key is associated with an organization. If you have multiple organizations in your MongoDB environment that you'd like to integrate with JupiterOne, you'll need to create an API Key for each organization and set up a separate integration instance for each organization/API Key.
- Log in to your MongoDB Atlas account.
- Follow the detailed instructions in the MongoDB Atlas documentation to create both a public and private key. Note that the private key will only be shown once, so be sure to save it in a secure location.
By default, MongoDB Atlas turns on the setting to require an IP Access List on the organization level. In order for JupiterOne to successfully connect to your MongoDB Atlas environment, you will need to toggle the setting Require IP Access List for the Atlas Administration API
to OFF
. You can find this under Organization settings.
Configuration in JupiterOne
- From the top-bar menu, select Integrations.
- Scroll to, or search for, the MongoDB Atlas integration tile and click it.
- Click the New Instance button and configure the settings:
- Enter the public key into the Public Key field.
- Enter the private key into the Private Key field.
- Test your credentials and configuration by clicking the Test Credentials button.
- Enter the Account Name by which you'd like to identify this MongoDB
instance in JupiterOne. Ingested entities will have this value stored in
tag.AccountName
when Tag with Account Name is checked.
- Click the Create button to complete the integration.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data about your MongoDB environment within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Data Model
Entities
The following entities are created:
Resources | Entity _type | Entity _class |
---|---|---|
API Key | mongodb_api_key | AccessKey |
Cluster | mongodb_cluster | Cluster |
Organization | mongodb_organization | Organization |
Project | mongodb_project | Project |
Role | mongodb_role | AccessRole |
Team | mongodb_team | UserGroup, Team |
User | mongodb_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
---|---|---|
mongodb_api_key | HAS | mongodb_role |
mongodb_organization | HAS | mongodb_api_key |
mongodb_organization | HAS | mongodb_project |
mongodb_organization | HAS | mongodb_team |
mongodb_organization | HAS | mongodb_user |
mongodb_project | HAS | mongodb_api_key |
mongodb_project | HAS | mongodb_cluster |
mongodb_project | OWNS | mongodb_role |
mongodb_project | HAS | mongodb_team |
mongodb_project | HAS | mongodb_user |
mongodb_team | HAS | mongodb_role |
mongodb_team | HAS | mongodb_user |
mongodb_user | ASSIGNED | mongodb_role |