# MongoDB Atlas

MongoDB Atlas is a fully managed and scalable cloud database service. It provides a flexible and secure platform for storing and managing data across various applications.

Developers can easily deploy, manage, and scale MongoDB databases in the cloud. Features like automated backups, global clusters, and real-time monitoring simplify database management.

Through this integration, Apono helps you discover and securely manage access to the resources in your MongoDB Atlas instance.

***

### Prerequisites

<table><thead><tr><th width="260">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>Apono Connector</strong></td><td><p>On-prem connection serving as a bridge between a MongoDB Atlas instance and Apono:</p><ul><li><a href="../../aws-environment/apono-connector-for-aws">AWS</a></li><li><a href="../../azure-environment/apono-connector-for-azure">Azure</a></li><li><a href="../../gcp-environment/apono-connector-for-gcp">GCP</a></li><li><a href="../../kubernetes-environment/apono-connector-for-kubernetes">Kubernetes</a></li></ul></td></tr><tr><td><strong>Atlas CLI</strong></td><td><a href="https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli/">Command-line interface</a> used to manage Atlas resources</td></tr><tr><td><strong>MongoDB Atlas Information</strong></td><td><p>Information for the database instance to be integrated:</p><ul><li><a href="https://www.mongodb.com/docs/atlas/tutorial/manage-project-settings">Project ID</a></li><li><a href="https://www.mongodb.com/docs/atlas/manage-database-deployments">Cluster Name</a></li><li><a href="https://www.mongodb.com/docs/atlas/manage-database-deployments">Cluster Type</a></li><li><a href="https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/">Private Endpoint ID</a></li></ul></td></tr></tbody></table>

***

### Create a project owner API key

A project owner API key enables Apono to control Atlas user access across a [single](#single-project) or [multiple](#multiple-projects) projects.

{% tabs %}
{% tab title="Single Project" %}
If you have a single MongoDB Atlas project, you can use a project owner API key to manage it through Apono.

Follow these steps to create a project owner API key:

1. At the Atlas CLI prompt, run the following command. Be sure to replace `#PROJECT_ID` with the project ID that contains the cluster you want to integrate.

{% code overflow="wrap" %}

```sh
atlas projects apiKeys create --desc cli-created --projectId "#PROJECT_ID" --role GROUP_OWNER
```

{% endcode %}

2. Copy the public and private API key in the response.
3. [Create a secret](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret) with the credentials from step **2**. Use the following key-value pair structure when generating the secret. Be sure to replace `#PUBLIC_KEY` and `#PRIVATE_KEY` with actual values.

```json
"public_key": "#PUBLIC_KEY",
"private_key": "#PRIVATE_KEY"
```

{% hint style="success" %}
You can also input the user credentials directly into the Apono UI during the [integration process](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret#apono).
{% endhint %}

You can now [integrate MongoDB Atlas](#integrate-mongodb-atlas).
{% endtab %}

{% tab title="Multiple Projects" %}
If you have multiple MongoDB Atlas projects, you can use a single project owner API key to manage them all through Apono.

Follow these steps to create and associate a project owner API key:

1. At the Atlas CLI prompt, run the following command. Be sure to replace `#PROJECT_ID` with the project ID that contains the cluster you want to integrate.

{% code overflow="wrap" %}

```sh
atlas projects apiKeys create --desc cli-created --projectId "#PROJECT_ID" --role GROUP_OWNER
```

{% endcode %}

2. Copy the public and private API key in the response.
3. List all your Atlas projects and their IDs.

```bash
atlas projects list
```

4. For each additional project ID, assign the public API key. Be sure to replace `#API_KEY_ID` with your public API key from step **2** and `#PROJECT_ID` with the project ID of the additional project to associate with the API key.

{% code overflow="wrap" %}

```bash
atlas projects apiKeys assign #API_KEY_ID --role GROUP_OWNER --projectId #PROJECT_ID
```

{% endcode %}

5. [Create a secret](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret) with the credentials from step **2**. Use the following key-value pair structure when generating the secret. Be sure to replace `#PUBLIC_KEY` and `#PRIVATE_KEY` with actual values.

```json
"public_key": "#PUBLIC_KEY",
"private_key": "#PRIVATE_KEY"
```

{% hint style="success" %}
You can also input the user credentials directly into the Apono UI during the [integration process](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret#apono).
{% endhint %}

You can now [integrate MongoDB Atlas](#integrate-mongodb-atlas).
{% endtab %}
{% endtabs %}

***

## Integrate MongoDB Atlas

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-d4ba4c65e054fd35b5f5365798f467fa93c0c048%2Fintegrate-mongodb-atlas.png?alt=media" alt="" width="563"><figcaption><p>MongoDB Atlas tile</p></figcaption></figure>

{% hint style="success" %}
You can also use the steps below to integrate with Apono using Terraform.

In step **11**, instead of clicking **Confirm**, follow the **Are you integrating with Apono using Terraform?** guidance.
{% endhint %}

Follow these steps to complete the integration:

1. On the [**Catalog**](https://app.apono.io/catalog?search=mongodb+atlas) tab, click **MongoDB Atlas**. The **Connect Integration** page appears.
2. Under **Discovery**, select one or multiple resource types.

{% hint style="info" %}
Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.
{% endhint %}

3. Click **Next**. The **Apono connector** section expands.
4. From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

{% hint style="success" %}
If the desired connector is not listed, click **+ Add new connector** and follow the instructions for creating a connector ([AWS](https://docs.apono.io/docs/aws-environment/apono-connector-for-aws), [Azure](https://docs.apono.io/docs/azure-environment/apono-connector-for-azure), [GCP](https://docs.apono.io/docs/gcp-environment/apono-connector-for-gcp), [Kubernetes](https://docs.apono.io/docs/kubernetes-environment/apono-connector-for-kubernetes)).
{% endhint %}

5. Click **Next**. The **Integration Config** section expands.
6. Define the **Integration Config** settings.

   <table><thead><tr><th width="224">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Integration Name</strong></td><td>Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow</td></tr><tr><td><strong>Project Id</strong></td><td>Unique identifier assigned to each project within MongoDB Atlas</td></tr><tr><td><strong>Cluster Name</strong></td><td>Name for a database cluster in MongoDB Atlas, serving as an identifier within a project</td></tr><tr><td><strong>Cluster Type</strong></td><td>Configuration of a MongoDB Atlas cluster</td></tr><tr><td><strong>Private Endpoint Id</strong></td><td>(Optional) Unique identifier for a private endpoint in MongoDB Atlas</td></tr></tbody></table>
7. Click **Next**. The **Secret Store** section expands.
8. [Associate the secret or credentials](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret).
9. Click **Next**. The **Get more with Apono** section expands.
10. Define the **Get more with Apono** settings.

    <table><thead><tr><th width="223">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Credential rotation period (in days)</strong></td><td><p>(Optional) Number of days after which the database credentials must be rotated</p><p>Learn more about the <a href="../../architecture-and-security/credentials-rotation-policy">Credentials Rotation Policy</a>.</p></td></tr><tr><td><strong>User cleanup after</strong> <strong>access is revoked (in days)</strong></td><td><p>(Optional) Defines the number of days after access has been revoked that the user should be deleted</p><p><br>Learn more about <a href="../../architecture-and-security/periodic-user-cleanup-and-deletion">Periodic User Cleanup &#x26; Deletion</a>.</p></td></tr><tr><td><strong>Custom Access Details</strong></td><td>(Optional) Instructions explaining how to access this integration's resources<br><br>Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to <strong>400 characters</strong>.<br><br>To view the message as it appears to end users, click <strong>Preview</strong>.</td></tr><tr><td><strong>Integration Owner</strong></td><td><p>(Optional) Fallback approver if no <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owner</a> is found<br><br>Follow these steps to define one or several integration owners:</p><ol><li>From the <strong>Attribute</strong> dropdown menu, select <strong>User</strong> or <strong>Group</strong> under the relevant identity provider (IdP) platform.</li><li>From the <strong>Value</strong> dropdown menu, select one or multiple users or groups.</li></ol><p><br><strong>NOTE</strong>: When <strong>Resource Owner</strong> is defined, an <strong>Integration Owner</strong> must be defined.</p></td></tr><tr><td><strong>Resource Owner</strong></td><td><p>(Optional) Group or role responsible for managing access approvals or rejections for the resource<br><br>Follow these steps to define one or several <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owners</a>:</p><ol><li>Enter a <strong>Key name</strong>. This value is the name of the tag created in your cloud environment.</li><li>From the <strong>Attribute</strong> dropdown menu, select an attribute under the IdP platform to which the key name is associated.<br><br>Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.</li></ol><p><br><strong>NOTE</strong>: When this setting is defined, an <strong>Integration Owner</strong> must also be defined.</p></td></tr></tbody></table>
11. Click **Confirm**.

<details>

<summary>💡Are you integrating with Apono using Terraform?</summary>

If you want to integrate with Apono using Terraform, follow these steps instead of clicking **Confirm**:

1. At the top of the screen, click **View as Code**. A modal appears with the completed Terraform configuration code.
2. Click to copy the code.
3. Make any additional edits.
4. Deploy the code in your Terraform.

Refer to [Integration Config Metadata](https://docs.apono.io/metadata-for-integration-config/integration-metadata/mongodb-atlas) for more details about the schema definition.

</details>

Now that you have completed this integration, you can [create access flows](https://docs.apono.io/docs/access-flows/access-flows) that grant permission to your MongoDB Atlas instance.

## Limitations

Please note: due to [Mongo Atlas limitations](https://www.mongodb.com/docs/atlas/security-add-mongodb-roles/#considerations), only 100 custom roles can be created per tenant. This may cause access requests to fail if the limit is exceeded.