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, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that API Key is selected as the Authorization type.
4. Ensure that the Token Name is x-api-key
5. Enter the API key.
6. Ensure that Add to Header is selected.
7. 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. In Oomnitza, click Configuration > Integrations > Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

1. Click Edit .
2. Make your changes.

Editing the credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Selecting Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

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. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. 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. Select the Unique checkbox.
   5. Click CREATE. 
3. Ensure that the Email is mapped to the:
   1. Username field on the Oomnitza side (required for integration).
   2. Email field on the Oomnitza side (required for integration).
4. Select the Role field on the Oomnitza mapping side.
5. Choose a suitable role from the list (a defined role is necessary for the integration)
6. Assign a sync key to a unique field, such as the Email.
7. Click UPDATE.

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

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

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 Using 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.

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the API block

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.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.

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