Creating workflows for Kandji assets

Once you have created the Kandji Automated Device Enrollment assets load, or the Kandji assets and software load you can get started creating workflows for Kandji assets.

To get started creating Kandji assets you can follow the steps in Using the API block. To locate the available presets, enter Kandji in the Select Preset search field. 

For additional configuration information refer to the list of Kandji presets below:

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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• Your subdomain, which should be derived from the global variable you created when Setting the Kandji subdomain as a global variable. Alternatively, click Set Manually to manually enter your subdomain.
• Your Kandji Device ID field, in the format {{kandji_device_id}}. You can map the Kandji Device Id to this field by following the mapping steps in the Kandji Automated Device Enrollment assets load, or the Kandji assets and software load.

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 positive and negative responses.
   

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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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}}.You can map the Kandji Device Id to this field by following the mapping steps in the Kandji Automated Device Enrollment assets load, or the Kandji assets and software load.
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 positive and negative responses.

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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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}}.You can map the Kandji Device Id to this field by following the mapping steps in the Kandji Automated Device Enrollment assets load, or the Kandji assets and software load.
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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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}}.You can map the Kandji Device Id to this field by following the mapping steps in the Kandji Automated Device Enrollment assets load, or the Kandji assets and software load.

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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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:

• You Kandji credentials that you added to Oomnitza in Adding your Kandji details in Oomnitza
• 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.

Reference articles for workflows

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