MongoDB Atlas Portal

Create an integration to manage access to a MongoDB Atlas Portal instance and its resources

Apono’s MongoDB Atlas integration enables you to securely manage just-in-time (JIT) access to your Atlas Organizations and Projects. You can connect Apono to a single cluster or discover multiple clusters.

---

Single cluster

With the single-cluster integration, Apono connects directly to one MongoDB Atlas cluster and discovers all of its resources for streamlined access management.

Prerequisites

Item	Description
Apono Connector	On-prem connection serving as a bridge between a MongoDB Atlas instance and Apono: AWS Azure GCP Kubernetes
Atlas Command Line Interface (Atlas CLI)	Command line interface for provisioning and managing Atlas database deployments from the terminal
MongoDB Atlas Info	Information for the MongoDB Atlas UI resources to be integrated: Cluster name Organization ID

Create an API key

You must create an API key with the Organization User role for the Apono connector.

Follow these steps to create the API key:

1. In the Atlas CLI, create the API key. The following command will return the public and private API keys in the response.

Be sure to replace <ORGANIZATION_ID> with the organization ID of the MongoDB Atlas UI to integrate.

atlas organizations apiKeys create --role ORG_OWNER --desc apono_connector --orgId <ORGANIZATION_ID>

1. Using the keys from the previous step, create a secret for the MongoDB Atlas UI instance.

"public_key": "#PUBLIC_KEY"
"private_key": "#PRIVATE_KEY"

You can now integrate your MongoDB Portal resources.

Integrate MongoDB Atlas Portal

Mongo Atlas Portal tile

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.

Follow these steps to complete the integration:

1. On the Catalog tab, click Mongo Atlas Portal. The Connect Integration page appears.

2. Under Discovery, click one or both resource types to sync with Apono.

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.

1. Click Next. The Apono connector section expands.

2. From the dropdown menu, select a connector.

If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).

1. Click Next. The Integration Config section expands.

2. Define the Integration Config settings.

   Setting	Description
   Integration Name	Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow
   Organization ID	ID of the organization of the MongoDB Atlas UI instance to connect

3. Click Next. The Secret Store section expands.

4. Associate the secret or credentials from step 2 of the previous section.

5. Click Next. The Get more with Apono section expands.

6. Define the Get more with Apono settings.

   Setting	Description
   Credential Rotation	(Optional) Number of days after which the database credentials must be rotated Learn more about the Credentials Rotation Policy.
   User cleanup after access is revoked (in days)	(Optional) Defines the number of days after access has been revoked that the user should be deleted Learn more about Periodic User Cleanup & Deletion.
   Custom Access Details	(Optional) Instructions explaining how to access this integration's resources 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 400 characters. To view the message as it appears to end users, click Preview.
   Integration Owner	(Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners: From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform. From the Value dropdown menu, select one or multiple users or groups. NOTE: When Resource Owner is defined, an Integration Owner must be defined.
   Resource Owner	(Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners: Enter a Key name. This value is the name of the tag created in your cloud environment. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. 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. NOTE: When this setting is defined, an Integration Owner must also be defined.

7. Click Confirm.

💡Are you integrating with Apono using Terraform?

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 for more details about the schema definition.

Now that you have completed this integration, you can create access flows that grant permission to your MongoDB Atlas UI Organizations and Projects.

---

Multiple clusters (deep discovery)

Apono provides enhanced integration capabilities with MongoDB Atlas Portal, permitting the discovery and management of multiple clusters simultaneously.

To discover multiple clusters in an Organization, Apono creates a Sub Integration for every discovered cluster, with its own Databases, Documents, and Roles.

Deep discovery has the following limitations:

• Deep discovery currently supports only AWS and Azure secret stores.

• All Apono connectors must have proper network access to their MongoDB Atlas clusters.

Prerequisites

Item	Description
MongoDB Atlas Account	MongoDB Atlas account with organization-level access
Apono Connector	On-prem connection serving as a bridge between a MongoDB Atlas instance and Apono: AWS Azure GCP Kubernetes
Atlas Command Line Interface (Atlas CLI)	Command line interface for provisioning and managing Atlas database deployments from the terminal
MongoDB Atlas Info	Information for the MongoDB Atlas UI resources to be integrated: Cluster name Organization ID

Create an API key

You must create an API key with the Organization Owner role for the Apono connector.

Follow these steps to create the API key:

1. In the Atlas CLI, create the API key. The following command will return the public and private API keys in the response.

Be sure to replace <ORGANIZATION_ID> with the organization ID of the MongoDB Atlas UI to integrate.

atlas organizations apiKeys create --role ORG_OWNER --desc apono_connector --orgId <ORGANIZATION_ID>

1. Using the keys from the previous step, create a secret for the MongoDB Atlas UI instance.

"public_key": "#PUBLIC_KEY"
"private_key": "#PRIVATE_KEY"

Only AWS Secret Store and Azure Vault are supported for this integration at this time.

Integrate MongoDB Atlas Portal

Mongo Atlas Portal tile

You can also use the steps below to integrate with Apono using Terraform.

In step 12, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

Follow these steps to complete the integration:

1. On the Catalog tab, click Mongo Atlas Portal integration. The Connect Integration page appears.

2. Under Discovery, click one or both resource types to sync with Apono.

3. Select one or several sub integrations:

   1. Under Connect Sub Integration, select Cluster and any child resource.

   2. (Optional) Select one or more additional sub integrations.

      

      Directory section

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.

1. Click Next. The Apono connector section expands.

2. From the dropdown menu, select a connector.

If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).

1. Click Next. The Integration Config section expands.

2. Define the Integration Config settings.

   Setting	Description
   Integration Name	Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow
   Organization ID	ID of the organization of the MongoDB Atlas UI instance to connect

3. Click Next. The Secret Store section expands.

4. Associate the secret or credentials from step 2 in the previous section

5. Click Next. The Get more with Apono section expands.

6. Define the Get more with Apono settings.

   Setting	Description
   Credential Rotation	(Optional) Number of days after which the database credentials must be rotated Learn more about the Credentials Rotation Policy.
   User cleanup after access is revoked (in days)	(Optional) Defines the number of days after access has been revoked that the user should be deleted Learn more about Periodic User Cleanup & Deletion.
   Custom Access Details	(Optional) Instructions explaining how to access this integration's resources 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 400 characters. To view the message as it appears to end users, click Preview.
   Integration Owner	(Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners: From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform. From the Value dropdown menu, select one or multiple users or groups. NOTE: When Resource Owner is defined, an Integration Owner must be defined.
   Resource Owner	(Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners: Enter a Key name. This value is the name of the tag created in your cloud environment. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. 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. NOTE: When this setting is defined, an Integration Owner must also be defined.

7. Click Confirm to complete the setup.

💡Are you integrating with Apono using Terraform?

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 for more details about the schema definition.

Tag the MongoDB Atlas cluster

Follow these steps to tag the cluster:

1. In your MongoDB Atlas cluster, navigate to the Clusters or Overview page to manage your tags.

2. For clusters in different networks or VPCs, tag each cluster with the Apono connector ID:

   1. Enter apono-connector-id for the Key.

   2. Enter the ID of the Apono connector in the cluster's network for the Value.

Each network or VPC hosting cluster must have a unique Apono connector.

1. Tag each cluster for the type of Apono connection.

Standard connection

No additional configuration needed.

Private connection

1. Enter apono-connection-type for the Key.

2. Enter Private for the Value.

Private endpoint connection

1. Enter apono-connection-type for the Key.

2. Enter PrivateEndpoint for the Value.

3. Enter apono_private_endpoint_id for the Key.

4. Enter the private endpoint ID for the Value.

Now that you have completed this integration, you can create access flows that grant permission to your MongoDB Atlas UI Organizations and Projects.