Skip to main content
Sign in

Creating an extended integration for Kandji assets and software

Caroline Maguire
  • June 13, 2022 08:36
  • Updated

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and Kandji 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 mobile asset, software, and user information
  • Configurable reports to share information about mobile assets and users with your colleagues and management
  • Configurable workflows that you can easily create to automate such tasks relating to Kandji as:
    • Restarting, erasing, locking, and shutting down devices.
    • Getting asset information.
    • Clearing a device passcode and setting a device name.

Kandji is an Apple device management solution. For further information, refer to the Kandji website.

Navigation

small_blue_link.svgBefore you start

small_blue_link.svgCreating the user integration

small_blue_link.svgCreating custom mappings

small_blue_link.svgCreating workflows

Creating asset workflows with the API block

Get Asset Details

Erase Device

Lock Device

Device Restart

Set Device Name

Shutdown Device

Unlock Account

Clear Passcode

Before you start

Before you can configure any of the available workflows with Oomnitza, you first need to enter your credentials in Oomnitza. For further information, refer to Adding your Kandji details in Oomnitza.

Creating the asset integration

Info and connect details

  1. From the menu, select Configuration > Integrations.
  2. Click Integrations List View IntegrationsListView.svg. 
  3. On the Integrations page, scroll down to the Extended section for Assets.
  4. Click NEW INTEGRATION.
  5. In the New Asset Integration sidebar, click Kandji.
  6. To integrate Oomnitza with the Kandji Asset Load (with Software), click APPLY and then click NEXT twice.

Connect page

  1. Enter a descriptive name for the integration such as Kandji Devices and Software. That'll be the name of the integration that is shown on the Integrations page.
  2. To retrieve software information, select Software.
  3. Select Cloud as the installation type.
  4. From the Credentials list, select the credentials from the Oomnitza vault that you added for the connection.
  5. From the Integration Preferences list, select Create & Update. 
  6. Enter the name of the user of the integration.
  7. Enter your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL
  8. Click Next.

Creating custom mappings

Map the Kandji fields to Oomnitza fields and create custom mappings to get the information that you need to manage your assets.

  1. Click SMART MAPPING. 
  2. Create a custom mapping for the Kandji Device ID. To do this, complete the following steps:
    1. Select the down arrow on the Device Id field that you want to map.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field to Kandji Device ID
    4. Click CREATE. 
  3. Map and assign a sync key to the Serial Number field.
  4. Click NEXT.

Standard Kandji to Oomnitza mappings

The following Kandji fields can be mapped to Oomnitza: 

Asset Tag
Blueprint ID
Connector Sync Time
Device ID
Device Name
Last Check In
Model
OS Version
Platform
Serial Number
User

Ensure that you select one of the fields as the Sync Key such as Device ID. 

blue_link.svg Learn more about mapping

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

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

Schedule

By default, Kandji asset and software 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 what information is collected now, click the tile on the Integrations page and click RUN.

edit-integration.svg

Figure: Mock-up for illustration purposes

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. 

Tip
To view the information that is collected about your mobile assets, click Assets. To view the information about software , click an asset and then click the Software tab.

Creating workflows

Creating asset workflows with the API block

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

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

Get Asset Details
Erase Device
Lock Device
Device Restart
Set Device Name
Device Shutdown
Unlock Account
Clear Passcode

Using the Kandji Get Asset Details preset

The Kandji Get Asset Details preset returns the device details for a specified Device ID, including a list of device users. When you select this preset, enter the following information in the Configure section:

Use the Advanced Mode to map the API response. To do this, complete the following steps:

    1. In the API block window, click the Advanced Mode button located in the upper right of the window.
    2. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza. Once you have the entire response, you should then map individual JSON values to custom fields, as per the example below. For further information, refer to the Mapping Response variables.
      kandji_response.PNG

For further information, and for an overview of the values returned in the Get Asset Details response, refer to the Kandji API Documentation: Get Device Details.

Using the Kandji Erase Device preset

The Kandji Erase Device preset sends an MDM (Mobile Device Management) command to erase the device. When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL
  • An unlock PIN (6 digits) that will be required to use the device after the erase.

Use the Advanced Mode to configure the message payload. To do this, complete the following steps:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. In the Information tab, you will notice that the Kandji asset id is referenced in the field {{kandji_device_id}} that you created in Creating custom mappings. If you did not create this custom mapping, you can replace the value n the URL with the correct field name or asset id. 
  3. In the Body tab, you can modify, update or add fields that will be used in the request payload. For example, if you want to preserve the data plan on an iPhone or iPad with eSIM functionality set the PreserveDataPlan to true. For information on the fields that are permitted in the request payload, refer to the Kandji API documentation: Erase Device.
  4. In the Response tab, you can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza. Once you have the entire response, you can then map individual JSON values to custom fields. For further information, refer to the Mapping Response variables.

Using the Kandji Lock Device preset

The Kandji Lock Device preset sends an MDM command to remotely lock a device. For macOS clients, an unlock PIN will be created, and returned in the response.

Warning
For a Mac with Apple silicon running a version of macOS before 11.5 this preset deactivates the Mac. To reactivate, the Mac requires a network connection and authentication by a Secure Token enabled local administrator.

When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL

Use the Advanced Mode to configure the message payload. To do this, complete the following steps:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. In the Information tab, you will notice that the Kandji asset id is referenced in the field {{kandji_device_id}} that you created in Creating custom mappings. If you did not create this custom mapping, you can replace the value n the URL with the correct field name or asset id. 
  3. Select the Response tab. For macOS clients, you can map the unlock PIN returned in the response by placing {{response.PIN}} in the Response field and mapping it to a custom  Oomnitza field, such as{{kandji.pin}}. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

For further information, refer to the Kandji API Documentation: Lock Device.

Using the Kandji Device Restart preset

The Kandji Device Restart preset sends an MDM command to remotely restart a device. 

When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL

Use the Advanced Mode to configure the message payload. To do this, complete the following steps:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. In the Information tab, you will notice that the Kandji asset id is referenced in the field {{kandji_device_id}} that you created in Creating custom mappings. If you did not create this custom mapping, you can replace the value n the URL with the correct field name or asset id. 

This request doesn't return a response body. For further information, refer to the Kandji API Documentation: Restart Device.

Using the Kandji Set Device Name preset

The Kandji Set Device Name preset sends an MDM command to set the device name. When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL
  • The new DeviceName, for example: Test Mac Mini.

Use the Advanced Mode to configure the message payload by following the steps in Using the Kandji Device Restart preset. This request doesn't return a response body. For further information, refer to the Kandji API Documentation: Set Name.

Using the Kandji Device Shutdown preset

The Kandji Device Shutdown preset sends an MDM command to shutdown a device. When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL.

Use the Advanced Mode to configure the message payload by following the steps in Using the Kandji Device Restart preset. This request doesn't return a response body. For further information, refer to the Kandji API Documentation: Shutdown.

Using the Kandji Unlock Account preset

The Kandji Unlock Account sends an MDM command to unlock a user account that locked by the system because of too many failed password attempts.

Note
This preset is available for macOS clients only.

When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL.
  • The UserName of the account you wish to unlock.

Use the Advanced Mode to configure the message payload by following the steps in Using the Kandji Device Restart preset. This request doesn't return a response body. For further information, refer to the Kandji API Documentation: Unlock Account.

Using the Kandji Clear Passcode preset

The Kandji Clear Passcode preset sends sends an MDM command to clear a device passcode.

Note
This preset is available for iPhone and iPad clients.

When you select this preset, enter the following information in the Configure section:

  • Your Kandji subdomain. For example, if the URL is
    https:// subdomain .kandji.io , you enter the highlighted part of the URL.

Use the Advanced Mode to configure the message payload by following the steps in Using the Kandji Device Restart preset. This request doesn't return a response body. For further information, refer to the Kandji API Documentation: Unlock Account.

For further information on workflows see:
small_blue_link.svg Understanding workflows
small_blue_link.svg Workflow block overview

Unleash the power of Oomnitza

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

  • Configure dashboards
  • Configure workflows 
  • Configure custom reports  

blue_link.svg See Getting started.

Did you know
You can also create extended connector integrations for Kandji users.
small_blue_link.svg Creating an extended integration for Kandji users

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk