Creating an extended integration for JumpCloud users

Let Oomnitza be your single source of truth!

You'll get visibility of your JumpCloud users as data from JumpCloud is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and JumpCloud in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows that you can easily create to automate such tasks as:
  • Retrieving the SaaS user role.
  • Getting, creating, deleting, and unlocking users.
  • Expiring a user's password.

Navigation

Adding the credentials

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

Create User

Delete User

Expire System Password

Unlock User

Creating Saas user workflows

User Role preset

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

JumpCloud uses API key authentication, which requires an API secret key and API ID. 

For further information consult the JumpCloud API documentation.

Adding the credentials

To stream JumpCloud user data into Oomnitza, complete the following steps:

1. In Oomnitza, go to Configuration>Security>Credentials.
2. Click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. Ensure that API Key is selected as the authorization type.
6. Enter x-api-key as the name of the token. 
7. Enter the API key.
8. Ensure that Add to Header is selected.
9. Save your changes.

Next

You use the credentials that you added to create and customize your JumpCloud integrations with Oomnitza.

Creating the user integration

Info and connect details

1. From the menu, go to Configuration>Integrations>Overview.
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for User Integrations.
4. Click NEW INTEGRATION.
5. In the New User Integration sidebar, click JumpCloud.
6. Click APPLY next to the JumpCloud User Load, and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

On the connect page, complete the following steps to connect the integration:

1. Enter a descriptive name for the integration such as JumpCloud User Load. This name will be displayed on the Integrations page once the setup is complete.
2. From the User Selection list, select User plus SaaS User or User only.
3. If you select User plus SaaS User and you have multiple instances of the same SaaS application, select the application from the SaaS Selection list. If you have a single instance of the SaaS application, skip this step.
4. From the installation type list, select Cloud.
5. From the Credentials list, select your credentials.
6. From the Integration Preferences list, select Update only.   
7. Enter the name of the user of the integration.
8. Click Next.

Creating custom mappings

Map the JumpCloud fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Create a custom mapping for the JumpCloud ID. To do this, complete the following steps:
   1. Select the down arrow on the ID field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to JumpCloud User Id.
   4. Click CREATE. 
2. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Map and assign a sync key to the Email field.
4. Click NEXT.

Note: For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard JumpCloud to Oomnitza mappings

The following JumpCloud fields can be mapped to Oomnitza:

Account Locked
Account Locked Date
Activated
Allow Public Key
Alternate Email
Company
Connect: Credentials
Connector Sync Time
Created
Disable Device Max Login Attempts
Displayname
Email
Employee Type
First Name
ID
Job Title
Last Name
Manager
Password Expiration Date
Password Expired
State
Suspended

Want to map more fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the JumpCloud to Oomnitza fields, click NEXT.

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Configure your schedule.
2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see the information that is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings. 

Creating workflows

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Creating user workflows with the API block. To locate the available presets, enter JumpCloud in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

• Your correct JumpCloud Credentials that you created in Adding the credentials.

The JumpCloud API block workflow comes with the following presets for users:

Create User
Delete User
Expire System Password
Unlock User

Using the JumpCloud Create User preset

The JumpCloud Create User preset allows you to to create a new system user. When constructing a workflow that uses this preset, the following information is required:

• Username. The username of the new user.
• Email address. The email of the new user.
• Firstname. The first name of the new user.
• Lastname. The last name of the new user.

There are also additional fields that can be reviewed and updated in the Body tab. To view the Body tab, do the following:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab and review the asset details.
3. Select the curly brackets to the right of the window to update or add additional fields.

For further information see JumpCloud REST API documentation: Create a system user.

Using the JumpCloud Delete User preset

The JumpCloud Delete User preset allows you to delete a particular system user. The JumpCloud user id is mandatory and required for this preset. The id is assumed to be stored in the JumpCloud User Id field that you created in Custom mappings. To manually modify the user id, complete the following steps:

1. 1. Click the Advanced Mode button located in the upper right of the window.
   2. In the Information tab, replace the variable {{jjump_cloud_user_id} in the URL field with the user id. 

For further information see JumpCloud REST API documentation: Delete a system user.

Using the JumpCloud Unlock User preset

The JumpCloud Unlock User preset allows you to unlock a user's account. The JumpCloud user id is mandatory and required for this preset. The id is assumed to be stored in the JumpCloud User Id field that you created in Custom mappings. You can follow the steps in Using the JumpCloud Delete User preset to manually modify the user id. 

For further information see JumpCloud REST API documentation: Unlock a system user.

Using the JumpCloud Expire System Password preset

The JumpCloud Expire System Password preset allows you to expire a user's password. The JumpCloud user id is mandatory and required for this preset. The id is assumed to be stored in the JumpCloud User Id field that you created in Custom mappings. You can follow the steps in Using the JumpCloud Delete User preset to manually modify the user id. 

For further information see JumpCloud REST API documentation: Expire a system user's password.

Creating Saas user workflows

You can create the SaaS User workflow by following the steps in Creating Saas user workflows. To locate the available presets, enter JumpCloud in the Select Preset search field. Select your preset of choice and enter the following information in the Configure section:

• Your correct JumpCloud Credentials that you created in Adding the credentials.

The SaaS User workflow block comes with one available preset, the JumpCloud User Role preset .

Using the JumpCloud User Role preset

The JumpCloud User Role preset enables you to read a user’s role from JumpCloud.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your users, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.

Did you know
You can also create extended connector integrations for JumpCloud assets.
Creating an extended integration for JumpCloud assets