# JumpCloud (cloud)

The NetSPI Platform has a broad integration with JumpCloud. This provides the NetSPI Platform visibility into system
and user assets.

This integration supports the JumpCloud product only.

Similar to our other integrations, the JumpCloud integration is read-only and does not perform actions to configure
systems or otherwise change anything about yourJumpCloud system.

## Supported asset types

Thr JumpCloud integration provides the NetSPI Platform visibility into the following asset types:

- Systems
- Users
- Applications
- IPV4 Addresses

## Data run frequency

The JumpCloud integration pulls data every 12 hours.

## Endpoints used

This integration needs access to the following API endpoints:

- `api/v2/systemgroups`
- `api/v2/systemgroups/{group_id}/members`
- `api/v2/systemgroups/{group_id}/users`
- `api/v2/systemgroups/{group_id}/associations`

## Required permissions

This integration needs an API key with the following access permissions:

- "Read-only" admin role

## Configuration steps

Use the section below for configuring JumpCloud to integrate with the NetSPI Platform.

### Step one: JumpCloud system configuration

1. Create a JumpCloud service account for the NetSPI Platform integration and select a user to associate with the API
key. This user must have at least a "read-only" admin role.

   !!!Note
   JumpCloud API Keys provide API access to specific user accounts. NetSPI recommends that a service account be
   created for this integration to use.
   !!!

2. Log in to JumpCloud from the dashboard with the user account from step 1 above.

3. On the dashboard, select on the *Settings* tab in the left menu and then *API Settings*.

4. Select the **Generate API Key** button and enter a name for your API key.

5. Select the **Generate** button to generate the API key, which will displayed on the screen.

6. Copy the API key and save it in a secure location.

   You can now use the API key to access the JumpCloud API.  When making API calls, you will need to provide the
   API key in the request header as "x-api-key".

   !!! Note
   Please note that you can only generate one API key per account. If you need to create multiple API keys, you can
   create multiple JumpCloud accounts.
   !!!

### Step two: NetSPI Platform CAASM configuration

Use the steps below to configure the JumpCloud Integration in the NetSPI Platform.

1. Log into the NetSPI Platform as a Client Admin user.

2. Navigate to *Settings -> CAASM Integrations* to display the Integrations page.

   ![Platform Integrations page](/static/caasm/integrations/integrations_landing.png "Platform Integrations page")

3. Select the *Integration Library tab -> Integration Categories / Identity and Access Management (IAM) -> JumpCloud Integration*.

   ![Integration Library tab](/static/caasm/integrations/jumpcloud_integration_1.png "Integration Library tab")

   This brings the JumpCloud integration card into focus.

   !!!Note
   You can also locate the integration card by:

      - Scrolling down the page on the *Integration Library* tab
      - Filter the integration options displayed by selecting any of the other left navigation choices besides
      *Integration Categories*, e.g., by *Modules* or *Integration Scopes* (cloud or on premise)
      - Enter the integration name in the Search integration bar
   !!!

4. Select the **Add** button on the JumpCloud card to display the JumpCloud integration configuration page.

   ![JumpCloud integration page](/static/caasm/integrations/jumpcloud_integration_2.png "JumpCloud integration page")

5. Select and enter values for the following fields to complete the JumpCloud integration setup.

   1. Select the integration type from the *Integration* drop-down list. In this case, *JumpCloud*, which is already
   selected by default.

   2. Select the integration scope from the *Scope* drop-down list. The JumpCloud integration must be able to talk to your
   JumpCloud server, which will typically live in the cloud. In most cases, this integration should run on the cloud scope.
   *Cloud* displays as the default value for the JumpCloud integration.

   3. Enter an integration name and description in the *Integration Name* and *Description* fields.

   4. Select the *Enabled* slider button to display as either on (blue) or off (light gray).

   5. Enter values in the JumpCloud API key created in the section above in the *API Key* field.

6. Select the **Create** button to save the integration. The new integration now displays on the
   *Applied Integrations* tab with its statuses: current and last run, last run time, and status (enabled/disabled).