JumpCloud Integration Setup

Getting Started

BalkanID recommends creating a separate service account for the purposes of this integration, instead of using personal or employee named accounts.

Requirements:

• API Key

• Organization ID

Obtain API Key

The API Key needs to be from an administrator account. To retrieve the API Key follow the JumpCloud instructions here: https://docs.jumpcloud.com/api/2.0/index.html#section/API-Key/Access-Your-API-Key.

Obtain Organization ID

To retrieve the Organization ID follow the JumpCloud instructions here: https://docs.jumpcloud.com/api/2.0/index.html#section/Multi-Tenant-Portal-Headers/To-Obtain-an-Individual-Organization-ID-via-the-UI.

Configure JumpCloud within your BalkanID tenant

1. Login to the BalkanID application and switch to the tenant you would like to add your integration to.

2. Head to Integrations > Add Integration, select JumpCloud.

   

   
3. Set up the Primary Application owner (mandatory) and the Description, if any. Set up Secondary Application Owner(s), if any.

   Select the Extraction Type. From here, you can configure your application using one of the following methods:

   1. Direct integration - Provide your API Key and Organization ID obtained above to set up a direct connection with BalkanID.

   2. SCIM integration - Provide SCIM server credentials to set up a SCIM connection with BalkanID.

   3. Manual file upload - Upload Entity and Entity Relations through a .CSV file upload. Contact the team for assistance with this.

   4. Automated upload using API - You can upload data using our Bulk APIs with the help of an API key which will be provided to you. Please refer to the entity and entity relation upload docs for specific instructions on uploading your data through the API.

   Note: For Last Login Days, pick the number of days you would like to monitor for last login. For example, if you select 90 then the integration will generate entitlements with a Permission named access in last 90 days that will have Permission Value true if last login was within last 90 days, and false otherwise.

   
4. Click on next to move onto Optional Configuration.

5. Fill Optional configuration, if required.

   
6. Once you filled in the information, click Save. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read Connected and the integration Message will read Data available.