Configure Atlas MongoDB API key

This process involves creating an API Key on MongoDB Atlas, for which Entitle requires Organization Owner permissions, and then configuring the API Key details on Entitle.

Managed resource types

Entitle manages the following resource types in the Atlas MongoDB integration:

• Projects
• Clusters
• Collections
• Databases

Atlas MongoDB - setting things up for Entitle’s access

Stage 1: Create an API key

If you want to create the token for the Partial functionality option, make sure the token's Admin Role setting is configured as Group Membership Admin and Report Admin roles.

To create an API Key:

1. On MongoDB Atlas, go to the Access Manager page for your organization, by clicking Access Manager on the sidebar, or clicking Access Manager on the navigation bar and then clicking your organization.
2. Click Create API Key.

The following screen is displayed:

3. Enter a Description.
4. In the Organization Permissions, select the Organization Owner option.
5. Click Next.
6. Copy and save the Public Key and the Private Key in a secure location.

Stage 2: Allow access for Entitle

Grant Entitle access to the following:

• The created API key
• The projects you wish to manage with Entitle

The IP addresses are determined by the deployment type of Entitle in your organization:

Self-Hosted solution - Please get the external IP address of the cluster (this is the IP from which the requests will be sent).
Fully-Cloud solution - There are 2 IP addresses which Entitle's cloud will reach your Atlas MongoDB instance from:

• 34.243.199.171
• 54.216.133.226

API key access

1. Under API Access List, click Add Access List Entry.
2. Enter the IP Address of the Entitle cluster.
3. Click Save, and then click Done.

Project-level access

1. Select the desired project in your organization.
2. Navigate to the 'Network Access' page.

3. Click 'Add IP Address'.
4. Enter the IP Address of the Entitle's cluster.

Create the integration in Entitle

At this point, you are ready to enter the API Key in Entitle. This step assumes that you have created a new MongoDB Atlas integration in Entitle. For more information on how to create a new integration, see the relevant section in the Entitle User Guide.

To configure the API Key details on Entitle:

1. As part of creating a new MongoDB Atlas integration in Entitle, on the Add Integration screen, scroll down to the Connection section.

2. In the connection window, add the following information between the double quotes:
   a. project_id (optional) – you can enter a specific project ID to limit the scope to a specific project. Otherwise, Entitle will have access to all projects.
   b. public_key – enter the previously saved public key.
   c. private_key - enter the previously saved public key.
3. The following options are available under the options section:
   a. connect_to_clusters – enter the value _true _if you want to grant Entitle access to objects that are under the cluster level (i.e., table level and collection level). Leaving the _false _value will grant access to the cluster level only.
   b. read_only – if you want to limit Entitle's access to read-only, enter the value _true.
4. Configure the required additional fields and click Save.