> ## Documentation Index
> Fetch the complete documentation index at: https://conductorone-docs-entitlement-lifecycle-sparse-acl.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up Rapid7 connector

> C1 provides identity governance for Rapid7. Integrate your Rapid7 instance with C1 for unified visibility and governance over user access.

## Availability

This connector works with Rapid7 products available on the Command Platform API (formerly Insight Platform API). Products that use a separate local API — such as the InsightVM console — are not supported.

## Capabilities

| Resource     | Sync                                                          | Provision                                                     |
| :----------- | :------------------------------------------------------------ | :------------------------------------------------------------ |
| Account      | <Icon icon="square-check" iconType="solid" color="#c937ae" /> | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |
| Organization | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |                                                               |
| Role         | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |                                                               |
| User Group   | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |                                                               |

The Rapid7 connector supports [automatic account provisioning](/product/admin/account-provisioning) on the Command Platform. New accounts receive an invitation email and set their own password.

<Note>
  **Role sync includes Rapid7's shared roles even when they don't appear in your account's role list.** The shared Administrator, View and Change, and View Only roles are assignable across your whole account, but Rapid7 only lists them in the role catalog for organizations subscribed to certain products. C1 always includes these three roles so any assignment referencing one still syncs correctly.
</Note>

<Note>
  **Role and group assignments sync across every organization in your account.** If your account has more than one organization, a user or group can hold different role assignments in each. C1 collects assignments from every organization, not just one.
</Note>

### Connector actions

Connector actions are custom capabilities that extend C1 automations with app-specific operations. You can use connector actions in the [Perform connector action](/product/admin/automations-steps-reference#perform-connector-action) automation step.

| Action name  | Additional fields                                                                                     | Description                                                                                                 |
| ------------ | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| update\_user | `user_id` (string, required), plus any of first name, last name, or preferred timezone (all optional) | Updates a Rapid7 account's first name, last name, or preferred timezone. Omitted fields are left unchanged. |

<Note>
  **Rapid7 accounts cannot be temporarily disabled on the Command Platform.** To revoke access, delete the account; the same user can be re-invited later. Role and product access on a user are managed in the Rapid7 admin UI.
</Note>

**Additional functionality:**

* Account creation via invitation email
* Account deletion
* Account profile updates via the `update_user` action

## Gather Rapid7 configuration information

Configuring the connector requires you to pass in information from Rapid7. Gather these configuration details before you move on.

<Warning>
  A user with **administrator** permissions in Rapid7 must generate the API key. The connector requires a **personal API key** (user key), not an organization API key. Organization keys only provide access to Rapid7 capability APIs and will cause the connector to fail with permission errors.
</Warning>

Here's the information you'll need:

* API Key
* Region

See the Rapid7 docs for information on how to acquire credentials: [View the documentation](https://docs.rapid7.com/insight/managing-platform-api-keys#generating-a-user-key)

## Configure the Rapid7 connector

<Warning>
  To complete this task, you'll need:

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Access to the set of Rapid7 configuration information gathered by following the instructions above
</Warning>

<Tabs>
  <Tab title="Cloud-hosted">
    **Follow these instructions to use a built-in, no-code connector hosted by C1.**

    <Steps>
      <Step>
        In C1, navigate to **Apps** > **Connectors** and click **Add connector**.
      </Step>

      <Step>
        Search for **Rapid7** and click **Add**.
      </Step>

      <Step>
        Choose where to add the connector: **Create a new app**, or **Add to an existing app** (then select the app).

        If you're creating a new app, choose whether to link it to an application discovered from your identity provider: select **Yes** and pick the IdP application, or **No** to continue with just the connector.
      </Step>

      <Step>
        Set the connector's **Name** and, optionally, a **Description**.
      </Step>

      <Step>
        Click the pencil icon next to **Owners** to choose who can configure and manage this connector.
      </Step>

      <Step>
        Click **Add**. The connector is created and its configuration page opens.
      </Step>

      <Step>
        Find the **Settings** area of the page and click **Edit**.
      </Step>

      <Step>
        Enter the configuration information from the previous section.
      </Step>

      <Step>
        Click **Save**.
      </Step>

      <Step>
        The connector's label changes to **Syncing**, followed by **Connected**. You can view the logs to ensure that information is syncing.
      </Step>
    </Steps>

    **Done.** Your Rapid7 connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    **Follow these instructions to use the Rapid7 connector, hosted and run in your own environment.**

    When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

    ### Resources

    [Contact C1's support team](mailto:support@conductorone.com) to download the latest version of the connector.

    ### Step 1: Set up a new Rapid7 connector

    <Steps>
      <Step>
        In C1, navigate to **Apps** > **Connectors** and click **Add connector**.
      </Step>

      <Step>
        Search for **Baton** and click **Add**.
      </Step>

      <Step>
        Choose where to add the connector: **Create a new app**, or **Add to an existing app** (then select the app).

        If you're creating a new app, choose whether to link it to an application discovered from your identity provider: select **Yes** and pick the IdP application, or **No** to continue with just the connector.
      </Step>

      <Step>
        Set the connector's **Name** and, optionally, a **Description**.
      </Step>

      <Step>
        Click the pencil icon next to **Owners** to choose who can configure and manage this connector.
      </Step>

      <Step>
        Click **Add**. The connector is created and its configuration page opens.
      </Step>

      <Step>
        In the **Settings** area of the page, click **Edit**.
      </Step>

      <Step>
        Click **Rotate** to generate a new Client ID and Secret.

        Carefully copy and save these credentials. We'll use them in Step 2.
      </Step>
    </Steps>

    ### Step 2: Create Kubernetes configuration files

    Create two Kubernetes manifest files for your Rapid7 connector deployment:

    #### Secrets configuration

    ```yaml theme={null}
    # baton-rapid7-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-rapid7-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 client secret>

      # Rapid7 config
      BATON_RAPID7_API_KEY: <Personal (not org) API Key for Rapid7>
      BATON_RAPID7_REGION: <Region for Rapid7 (e.g. us, us2, eu, au) See: https://docs.rapid7.com/insight/product-apis#supported-regions) and check your org settings to find your region>

    ```

    See the connector's README or run `--help` to see all available configuration flags and environment variables.

    #### Deployment configuration

    ```yaml expandable theme={null}
    # baton-rapid7.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: baton-rapid7
      labels:
        app: baton-rapid7
    spec:
      selector:
        matchLabels:
          app: baton-rapid7
      template:
        metadata:
          labels:
            app: baton-rapid7
            baton: true
            baton-app: rapid7
        spec:
          containers:
          - name: baton-rapid7
            image: public.ecr.aws/conductorone/baton-rapid7:latest
            imagePullPolicy: IfNotPresent
            env:
            - name: BATON_HOST_ID
              value: baton-rapid7
            envFrom:
            - secretRef:
                name: baton-rapid7-secrets
    ```

    ### Step 3: Deploy the connector

    <Steps>
      <Step>
        Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.
      </Step>

      <Step>
        Check that the connector data uploaded correctly. In C1, click **Apps**. On the **Managed apps** tab, locate and click the name of the application you added the rapid7 connector to. rapid7 data should be found on the **Entitlements** and **Accounts** tabs.
      </Step>
    </Steps>

    **Done.** Your Rapid7 connector is now pulling access data into C1.
  </Tab>
</Tabs>