This guide covers how to set up JumpCloud with Workbench.

Prerequisites

1. You must have admin access in Workbench to set up this integration.
2. You must have access to an account with the Administrator role and API access enabled. Note: The Administrator with Billing role can enable API access for others.

Quick Links

Setup includes the following steps (select any step for detailed instructions):

1. Create and Retrieve the JumpCloud API Key
2. Add JumpCloud as a Security Device in Workbench

Step 1: Create and Retrieve the JumpCloud API Key

The JumpCloud API Key is a secret key associated with an administrator account that grants full access to data accessible via the JumpCloud console. It is only displayed once when generated, so be sure to copy and save it immediately.

1. Log in to the JumpCloud Console.
2. Select your account initials (or profile avatar) in the top-right corner.
3. In the dropdown menu, select My API Key. If you do not see this option, contact an Admin with the Billing role to ensure API access is enabled for your account.
4. Select Generate New API Key. You may be prompted to set an expiration date for the key. For a security integration, selecting an appropriate expiration date (e.g., 90 days) and planning for regular rotation is a best practice.
5. Copy and save the generated API key in a safe place. This is the only time the full key will be visible, so be sure to copy and save it now.

Step 2: Add JumpCloud as a Security Device in Workbench

Now that you have the API key, you can add and configure the JumpCloud integration in Expel Workbench.

1. Log in to Workbench.
2. In the side menu, navigate to Organization Settings > Security Devices.
3. Select Add Security Device.
4. In the search box, type “JumpCloud” and then select the JumpCloud integration.
   
5. A configuration pane displays. Complete the fields as follows:
   1. Name - enter a name that might help you more easily identify this integration, such as “CompanyName JumpCloud”; this name will display in Workbench under the Name column, and is a text string that you can filter on.
   2. Location - enter the location of your integration, for example “cloud.” This is also a text string that you can filter on, so we recommend being consistent with location naming across your Expel integrations.
   3. JumpCloud API base URL - leave "https://api.jumpcloud.com" populated in this field. For EU tenants, enter "https://api.eu.jumpcloud.com".
   4. JumpCloud API key - enter the API key you saved in Step 1.
6. Select Save.
7. On the console access screen, select No thanks, I will not provide console access from the dropdown.
8. Select Save.
9. Your device should be created successfully within a few seconds. A few reminders:
   • After your connection is healthy, it will take some time for your device to begin polling and receiving data.
   • To check on the status, select the downward arrow for your device in the first column and choose View details.
   • Polling will happen first; data will be received after that. You must refresh the page to see updates.
   • If your device does not begin polling within 15 minutes, and does not begin receiving data within 30 minutes, contact our support team for help.
   • To check if alerts are coming through, navigate to Dashboards > Alert Analysis. Scroll to the device you want to check, and select the Expel Alerts tab to reveal more alert information. It can take 36 to 72 hours for alerts to appear after setup, as we tune your device.