Creating an extended integration for JumpCloud assets

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets 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 asset and software information
• Configurable reports to share information about assets and software with your colleagues and management such as corporate-wide reports that detail the distribution and status of the assets and software in your environment
• Configurable workflows that you can easily create to automate tasks such as:
  • Deleting, erasing, locking, restarting, and shutting down JumpCloud systems.

Navigation

Adding the credentials

Creating the asset integration

Creating custom mappings

Creating workflows

Creating asset workflows with the API block

Delete System

Erase System

Lock System

Restart System

Shutdown System

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 asset integration

To configure the integration for the JumpCloud Asset Load, complete the following steps:

1. In Oomnitza, click Configuration> Integrations> Overview.
2. Click Integrations List View.
3. Scroll down to the Extended section for asset integrations.
4. Click NEW INTEGRATION.
5. Select the integration in the sidebar.
6. Click ADD.

Integration Overview

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

• Integration preferences:  By default,  Create and Update are selected. To ensure that only live user records are synced with Oomnitza, select Update Only. When you run the integration, you can check the error logs to see the records that weren't uploaded and why they weren't uploaded. Then, you can decide whether to upload the user records that were skipped by changing your integration preference back to Create and Update.

Integration details

To review or update the integrations details, click the pencil:

1. Update the integration name if necessary. 
2. For installation type, ensure that Cloud is selected.
3. For integration preferences, select an option.
4. Enter the name of the integration user.

Credential details

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

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. Click the pencil.
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click the pencil.

Creating custom mappings

Map JumpCloud fields to Oomnitza fields to get the asset information that you need. For the field mapping, it is recommended to follow these steps:

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 assets field.
   3. Change the name of the field to JumpCloud System 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 assets field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Map and assign a sync key to the Serial Number field.
4. Click NEXT.

Tracking information for asset loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:   

• Connect: Credentials

Custom mappings

Active
Architecture
Connect: Credentials
Connector Sync Time
Created
Device User
Display Name
Hostname
ID
Organization
OS
OS Family
Password Last Valid
Remote IP
Serial Number
System Timezone
Template Name
Version

Did you know? 
You can define rules for your integration by selecting Edit integration at the top of the screen. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  

You can add new fields to your integration by selecting the + (Add) option. All you need to do is specify the field name and then enter the JSON path, for example {{response.email}}. See Creating custom API fields. 

Launching the integration

Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, we recommend that you complete the following steps

1. Select Launch to activate your integration.
2. Change your Integration preferences to Update only so that no records are imported and do a Test Run.
3. Click Sync Sessions and review the status of the integration. If you encounter any errors, see troubleshooting integrations.
4. When the test run has been completed, change your Integration preferences and click Run Now.

Getting your results
To view the information that is collected about your assets, click Assets. To view the information about software, click an asset and then click the Software tab. To view the information that is collected about your users, click People. 

Related Links

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

Creating workflows

Creating asset workflows with the API block

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

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

2. The JumpCloud system id is mandatory and required for all presets. For all of the below presets, the system id is assumed to be stored in the JumpCloud System Id field that you created in Creating custom mappings. To manually modify the system id, complete the following steps:

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

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

Delete System
Erase System
Lock System
Restart System
Shutdown System

Using the JumpCloud Delete System Preset

The Delete System preset allows you to delete a system from JumpCloud.

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

Using the JumpCloud Erase System Preset

The Erase System preset allows you run the erase command on the specified device. If a device is offline, the command will be run when the device becomes available. 

For further information see JumpCloud REST API documentation: Erase a System.

Using the JumpCloud Lock System Preset

The Lock System preset allows you run the lock command on the specified device. If a device is offline, the command will be run when the device becomes available.  

For further information see JumpCloud REST API documentation: Lock a System.

Using the JumpCloud Restart System Preset

The Restart System preset allows you run the restart command on the specified device. If a device is offline, the command will be run when the device becomes available.

For further information see JumpCloud REST API documentation: Restart a System.

Using the JumpCloud Shutdown System Preset

The Shutdown System preset allows you to run the shutdown command on the specified device. If a device is offline, the command will be run when the device becomes available

For further information see JumpCloud REST API documentation: Shutdown a System

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 assets, 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 Users.
Creating an extended integration for JumpCloud users