For Leen to authenticate with Rapid7 InsightVM, we require the following:

  1. Base URL: The Base URL or the Base Path for the Rapid7 InsightVM API. This is in the format: https://{region}.api.insight.rapid7.com.
  2. API Key: A unique API Key tied to a User or Organization in Rapid7. In the following section, we will cover how to create a new user with the minimum scope of access required to generate an API Key.
InsightVM must be connected to Rapid7’s Insight Cloud Platform, you can refer to the official Rapid7 documentation.

Permissions and User setup

We highly recommend creating a new user tied to an alias or a new email address so that usage of this user can be audited, and credentials are not tied to a real user. This is to prevent a user from being removed from Rapid7 and disrupting your data ingestion. Alternatively, you can create an Organization level API Key, but this is not recommended as it provides full access to all data in the organization.

Here is how you can create a new user with the minimum required permissions for the integration:

1

Create a new User

In the Rapid7 console, navigate to the Users page in the Insight Platform Home. Here, you will see an option to Create User.

2

Configure User

You will then be prompted to configure the user. Give the user a name and an email address.

3

Select User Permissions

Next, you will be asked to select the permissions for the user. Here,

  • Select the Product for which you would like to have access.
  • Select the View Only (Shared) Role for the user under the Roles tab.
4

Generate API Token

Now, once you login with the newly created user, navigate to the API Key Management page in the Insight Platform Home. Here, you will see an option to Generate New User Key. You will be asked to select the Organization and give the API Key a name.

Once you click Submit, you should see the API Key generated. Copy this API Key and store it securely.

For more information on how to create an API Key, you can refer to the official Rapid7 documentation.