MongoDB Atlas Administration

MongoDB Atlas Administration provides automated administration for MongoDB so customers can manage clusters, projects, users, and more.

Asset Types Fetched

  • Users, Activities , Application Settings, Compute Services , Databases , Alerts/Incidents, Application Resources

Before You Begin

APIs

Axonius uses the MongoDB Atlas Administration API (2.0).

The following API endpoints are used to fetch Application settings:

/api/atlas/v2/orgs/{orgId}/federationSettings

/api/atlas/v2/orgs

/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders

/api/atlas/v2/orgs/{orgId}/settings

/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs

/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects

/api/atlas/v2/groups/{groupId}/customDBRoles/roles

/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users

/api/atlas/v2/groups/{groupId}/users/{userId}

Required Permissions

The following permissions are required to fetch assets:

  • Organization Member - For fetching users
  • Read Write role - For fetching projects
  • Project Read Only - For fetching database users

Application Settings

In order to fetch application settings, the following permissions are required:

EndpointRequired Permission
/api/atlas/v2/orgs/{orgId}/federationSettingsTo use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected organization.
/api/atlas/v2/orgsTo use this resource, the requesting Service Account or API Key must have the Organization Member role.
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProvidersTo use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations.
/api/atlas/v2/orgs/{orgId}/settingsOrganization Member role.
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigsOrganization Owner role in one of the connected organizations.
/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects_
/api/atlas/v2/groups/{groupId}/customDBRoles/rolesProject Read Only role.
/api/atlas/v2/orgs/{orgId}/teams/{teamId}/usersOrganization Member role.
/api/atlas/v2/groups/{groupId}/users/{userId}Project Read Only role.

If optional permissions are not granted, the adapter will skip those specific settings and continue fetching all other available settings.

Deploying the Adapter in Axonius

Required Parameters

  1. Host Name or IP Address - The hostname or IP address of the MongoDB Atlas Administration server.

  2. Public API Key and Private Key- The API keys associated with a user account that has the Required Permissions to fetch assets.

  3. Organization ID - A unique 24-hexadecimal digit string that identifies the organization that contains your projects.

Optional Parameters

  1. Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

  2. HTTPS Proxy - Connect the adapter to a proxy instead of directly connecting it to the domain.

  3. HTTPS Proxy User Name - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.

  4. HTTPS Proxy Password - The password to use when connecting to the server using the HTTPS Proxy.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

Advanced Settings

📘

Note

Advanced settings can either apply to all connections for this adapter, or to a specific connection. Refer to ​Advanced Configuration for Adapters.

  1. Fetch Databases from Databases - Enable to fetch Databases from the Databases endpoint.
  2. Fetch AuditActivities from Audit Log - Enable to fetch AuditActivities from the Audit Log endpoint.
📘

Note

To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.

Supported From Version

Supported from Axonius version 6.1