How can we help?
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
Searches for and retrieves information about a device from Workspace One UEM.
This is a Premium Integration.
Authentication
This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type VMware Workspace One UEM.
To create a key of this type:
- In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
- Click on the + Create New Key button;
- On the resulting Create New Key form, choose VMware Workspace One UEM in the Type pick list;
- Give the VMware Workspace One UEM KeySafe key a Title (this is the name / identifier for the VMware Workspace One UEM account as you will see it when using the cloud automation node in your workflows);
- Optionally populate the Description field;
- Populate the following fields accordingly, then click the Create Key button to create your new key:
Name | Type | Description |
---|---|---|
Domain | string |
Your Workspace One UEM domain, for example: https://cn1498.awmdm.com |
Region | string |
The region where your Workspace One UEM service is located |
Client ID | string |
The Client ID for your Workspace One UEM oAuth Client |
Client Secret | string |
The Client Secret for your Workspace One UEM oAuth Client |
Access Token | string |
Generated by the integration, please leave this field empty |
Tip
VMware Workspace One UEM requires an OAuth Client to be created, that can then be used by these Hornbill integration operations. See the Client creation documentation for more information on creating these.
Revoking Access
If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.
Warning
This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked VMware Workspace One UEM account, so you will need to manage these workflows accordingly.
Input Parameters
Display Name | ID | Type | Description | Required | Supported Values |
---|---|---|---|---|---|
Device User | user |
string |
Searches for devices based on Username | No | None provided |
Device Model | model |
string |
Searches for devices based on the model eg. ‘iPhone’ | No | None provided |
Device Platform | platform |
string |
Searches for devices based on the platform eg. ‘Apple’ | No | None provided |
Ownership | ownership |
string |
Searches for devices based on the ownership of the device (C: Corporate, E: Employee, S: Shared) | No | C, E, S |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
Error Message | error |
string |
Any error message returned by Workspace One UEM |
Status Code | status |
string |
The status of the operation, ok/failed |
Device UdId | Udid |
string |
The unique identifier of your device |
Serial Number | SerialNumber |
string |
The serial number of your device |
Mac Address | MacAddress |
string |
The Mac Address of your device |
Imei | Imei |
string |
The Imei number for the device |
Device Name | DeviceName |
string |
The name of the device |
Device User Email | UserEmail |
string |
The email address of the device user |
Device Platform | DevicePlatform |
string |
The OS of the device |
Device Model | Model |
string |
The device model |
Device Operating System | OperatingSystem |
string |
The device operating system |
Device Last Seen | LastSeen |
string |
The date the device was last registered as used |
Device Cloud BackUp Enabled | CloudBackUp |
string |
Is the device’s cloud back up enabled |
Device Roaming? | Roaming |
string |
The Device is currently registered as Roaming |
Device's Carrier Name | carrierName |
string |
The name of the devices signal provider |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}