Creating workflows for Windows Autopilot devices

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets, software, and users as data from Windows Autopilot is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Windows Autopilot 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 information
• Configurable reports to share information with your colleagues and management
• Configurable asset workflows that you can easily create to automate tasks such as:
  • Workflows for assigning and unassigning Windows Autopilot users.
  • Workflows for creating, updating, and deleting Autopilot devices.
  • Workflows for retrieving detailed device information relating to Autopilot devices.

Let Oomnitza be your single source of truth!

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

Before you start

Creating workflows

Create asset workflows

Assign User To Asset
Create Asset
Delete Asset
Get Asset Details
Unassign User to Asset
Update Asset

Before you start

Before you create workflows, you need to have added your Windows Autopilot credentials to Oomnitza. Follow the steps in Adding Microsoft credentials to the vault in Oomnitza to add your OAuth credentials to Oomnitza. Select Microsoft from the SaaS dropdown and enter your Client ID, Secret, and Scope.

We recommend that you also create the extended integration for Windows Autopilot Devices. You can use the information retrieved in these integrations to trigger workflows that can create, update, and delete assets, and much more.

Creating workflows

Create asset workflows

To create an asset workflow, you must complete these steps:  

1. Click Configuration > Workflows 
2. Click Add (+) and select Assets from the list.
3. Drag and drop the API block onto the Sandbox.
4. Click Edit on the API block and enter Autopilot in the search field. 
5. Select a preset:
   • Windows Autopilot Assign User To Asset
   • Windows Autopilot Create Asset
   • Windows Autopilot Delete Asset
   • Windows Autopilot Get Asset Details
   • Windows Autopilot Unassign User to Asset
   • Windows Autopilot Update Asset
   • To choose a preset, click the forward arrow (>).
6. Select the credentials that you created in Adding Microsoft credentials to the vault in Oomnitza.
7. Configure the API Block following the preset instructions below, and save your changes.
8. Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to New you can trigger a workflow every time a new asset is created. Refer to Using the Begin block.
9. Connect the Blocks. 
10. Save, validate, and activate your workflow.

Using the Assign User to Asset preset

The Assign User to Asset preset assigns a user to an asset using the Autopilot Device ID. You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the Windows Autopilot Device ID is referenced in the property {{autopilot_device_id}}. Map the Device ID to this field by creating an asset integration and following the mapping steps in Creating custom mappings, otherwise, enter the Device ID.
3. Select the Body tab. The request body contains the email and username of the person the asset will be assigned to.
4. 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.

If successful, this workflow returns a 204 No Content response code. For further information, refer to Windows Autopilot API: assignUserToDevice action.

Using the Create Asset preset

The Create Asset preset enables you to create a new Autopilot device. When you select this preset you first need to supply the enrollment state of the Windows autopilot device. Possible values are: unknown, enrolled, pendingReset, failed, notContacted.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. The request body contains the values required to create the new device. These values are calling existing field names in Oomnitza, such as Model, so you need to make sure that these values exist in Oomnitza and are populated with information before you run this workflow. Alternatively, replace the values in the curly braces with the actual details and surround with double quotation marks: for example "model": "123456". For further information, refer to the request sample below.
3. 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.

If successful, this method returns a 201 Created response code and a windowsAutopilotDeviceIdentity object in the response body. For further information, refer to Windows Autopilot API: Create windowsAutopilotDeviceIdentity.

Request Sample

Request Body Schema

 
  
  {
  "@odata.type": "#microsoft.graph.windowsAutopilotDeviceIdentity",
 
   "groupTag": {{group_tag}},

  "purchaseOrderIdentifier": {{}},

  "serialNumber":{{serial_number}},

  "productKey": {{product_key}},

  "manufacturer": {{manufacturer}},

  "model": {{model}},

  "enrollmentState": "enrolled",

  "lastContactedDateTime": {{last_contacted_date_time}},

  "addressableUserName": "{{full_name}},

  "userPrincipalName": {{email},

  "resourceName": {{resource_name}},

  "skuNumber": {{sku_number}},

  "systemFamily": " {{system_family}},

  "azureActiveDirectoryDeviceId": {{azure_active_directory_device_id}},

  "managedDeviceId": {{managed_device_id}},

  "displayName": {{display_name}}
}

  

groupTag:Group Tag of the Windows autopilot device.

purchaseOrderIdentifier:Purchase Order Identifier of the Windows autopilot device.

serialNumber:Serial number of the Windows autopilot device.

productKey:Product Key of the Windows autopilot device.

manufacturer:.Oem manufacturer of the Windows autopilot device.

model:Model name of the Windows autopilot device.

enrollmentState:Intune enrollment state of the Windows autopilot device. Possible values are: unknown, enrolled, pendingReset, failed, notContacted.

lastContactedDateTime:Intune Last Contacted Date Time of the Windows autopilot device. Example: 2016-12-31T23:58:44.2908994-08:00

addressableUserName:.Addressable user name.

userPrincipalName:User Principal Name.

resourceName:Resource Name.

skuNumber:SKU Number.

systemFamily:System Family

azureActiveDirectoryDeviceId:AAD Device ID - to be deprecated

managedDeviceId:Managed Device ID


displayName:Display Name

Using the Delete Asset preset

The Delete Asset preset enables you to delete an Autopilot device using the Autopilot Device ID.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the Windows Autopilot Device ID is referenced in the property {{autopilot_device_id}}. Map the Device ID to this field by creating an asset integration and following the mapping steps in Creating custom mappings, otherwise, enter the Device ID.
3. 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.

If successful, this workflow returns a 204 No Content response code. For further information, refer to Windows Autopilot API: Delete windowsAutopilotDeviceIdentity.

Using the Get Asset Details preset

The Get Asset Details preset enables you to get the details of an Autopilot device using the Autopilot Device ID.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the Windows Autopilot Device ID is referenced in the property {{autopilot_device_id}}. Map the Device ID to this field by creating an asset integration and following the mapping steps in Creating custom mappings, otherwise, enter the Device ID.
3. 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.

If successful, this method returns a 200 OK response code and windowsAutopilotDeviceIdentity object in the response body. For further information, refer to Windows Autopilot API: Get windowsAutopilotDeviceIdentity.

Using the Unassign User to Asset preset

The Unassign User to Asset unassigns a user from an Autopilot Device, using the Autopilot Device ID.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the Windows Autopilot Device ID is referenced in the property {{autopilot_device_id}}. Map the Device ID to this field by creating an asset integration and following the mapping steps in Creating custom mappings, otherwise, enter the Device ID.
3. 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.

If successful, this workflow returns a 204 No Content response code. For further information, refer to Windows Autopilot API: unassignUserFromDevice action.

Using the Update Asset preset

The Update Asset preset updates properties on Autopilot devices, using the Autopilot Device ID.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the Windows Autopilot Device ID is referenced in the property {{autopilot_device_id}}. Map the Device ID to this field by creating an asset integration and following the mapping steps in Creating custom mappings, otherwise, enter the Device ID.
3. Select the Body tab. The request body contains the values required to update the new device. These values are calling existing field names in Oomnitza, such as Group Tag, so you need to make sure that these values exist in Oomnitza and are populated with information before you run this workflow. Alternatively, replace the values in the curly braces with the actual details and surround with double quotation marks: for example "groupTag": "123456". For further information, refer to the request sample below.
4. 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.

If successful, this workflow returns a 204 No Content response code. For further information, refer to Windows Autopilot API: updateDeviceProperties action.

Request Sample

Request Body Schema

{
 
   "groupTag": {{group_tag}},
 
  "addressableUserName": "{{full_name}},

  "userPrincipalName": {{email},

  "displayName": {{display_name}}
}
  

groupTag:Group Tag of the Windows autopilot device.

addressableUserName:.Addressable user name.

userPrincipalName:User Principal Name.

displayName:Display Name

Reference articles for workflows

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