Omnissa Workspace ONE
App · 25 actions
Manage devices with Omnissa Workspace ONE UEM: find, lock, wipe, sync and message devices, install profiles and apps, manage enrollment users, and read smart groups and organization groups.
Actions
| Action | What it does |
|---|---|
| Add device note | Add a note to a device's record in the Workspace ONE console. |
| Create user | Add an enrollment user, who can then enroll devices. |
| Deactivate user | Deactivate an enrollment user, so they can't enroll devices. |
| Delete device note | Delete a note from a device's record. |
| Delete user | Delete an enrollment user. |
| Enterprise wipe device | Remove everything Workspace ONE put on a device (managed apps, profiles, email and data) and unenroll it, leaving personal data in place. |
| Find device | Find one device by its serial number, UDID, Wi-Fi MAC address, IMEI or Exchange ActiveSync ID. |
| Get device | Get one device's details: its user, model, operating system, organization group, compliance and when it last checked in. |
| Get user | Get one enrollment user's details. |
| Install app on device | Install an internal or public app on one device. |
| Install profile on device | Install a device profile (Wi-Fi, email, restrictions...) on one device. |
| List device apps | List the apps on a device, managed or not, with versions. |
| List device notes | List the notes on a device's record. |
| List smart group devices | List the devices in a smart group. |
| Lock device | Lock a device's screen, as for a lost device. |
| Move device to organization group | Move a device to another organization group, so it gets that group's profiles, apps and settings. |
| Search apps | Find internal and public apps by name, type, platform or organization group, with how many devices have each. |
| Search devices | Find devices by user, model, platform, ownership, organization group, compliance or when they last checked in. |
| Search organization groups | Find organization groups by name, type or Group ID. |
| Search profiles | Find device profiles by name, platform, status or organization group. |
| Search smart groups | Find smart groups by name or organization group. |
| Search users | Find enrollment users by username, email, name, organization group or status. |
| Send message to device | Send a notification to a device through Workspace ONE Intelligent Hub (as a text message if the device isn't enrolled). |
| Sync or restart device | Ask a device to sync now, refresh its details in the console, or restart. |
| Update user | Change an enrollment user's name, email, phone numbers, department or employee ID. |
Add device note
Add a note to a device's record in the Workspace ONE console.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Note
notetextRequired - The note, at least 3 characters.
Outputs
device_idtext- The device's id
notetext- The note's text
note_idtext- The note's id
Example output
{
"device_id": "1234",
"note": "Screen replaced under warranty.",
"note_id": "55"
}Create user
Add an enrollment user, who can then enroll devices. A Basic user needs a first and last name, email and password.
Inputs
- Username
usernametextRequired - The username they enroll with.
- Organization group
organization_group_idtextRequired - The organization group they belong to.
- Sign-in type
security_typetext - How they sign in. Basic unless your tenant is linked to a directory.One of:
Basic(Basic (a password set here, default)),Directory(Directory (signs in with their directory account)). - Password
passwordtext - Their password. Required for a Basic user; not used for Directory.
- First name
first_nametext - Their first name. Required for a Basic user.
- Last name
last_nametext - Their last name. Required for a Basic user.
- Email
emailtext - Their email address. Required for a Basic user.
- Display name
display_nametext - The name shown for them.
- Phone number
phone_numbertext - Their phone number.
- Mobile number
mobile_numbertext - Their mobile number, for text messages.
- Department
departmenttext - Their department.
- Employee ID
employee_idtext - Their employee identifier.
Outputs
user_idtext- The new user's id
usernametext- Their username
uuidtext- The new user's UUID
Example output
{
"user_id": "5678",
"username": "jbloggs",
"uuid": "0f6e1b75-50c4-4b04-84fe-dab5d2b7467a"
}Deactivate user
Deactivate an enrollment user, so they can't enroll devices. Their devices stay enrolled.
Inputs
- User
enrollment_user_idtextRequired - The enrollment user. Pick one of the newest 500, or give their id from an earlier step (such as 'Search users').
Outputs
activetrue/false- False once deactivated
user_idtext- The user's id
Example output
{
"active": false,
"user_id": "5678"
}Delete device note
Delete a note from a device's record.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Note ID
note_idtextRequired - The note's id, from 'Add device note' or 'List device notes'.
Outputs
deletedtrue/false- True once deleted
device_idtext- The device's id
note_idtext- The note's id
Example output
{
"deleted": true,
"device_id": "1234",
"note_id": "55"
}Delete user
Delete an enrollment user.
Inputs
- User
enrollment_user_idtextRequired - The enrollment user. Pick one of the newest 500, or give their id from an earlier step (such as 'Search users').
Outputs
deletedtrue/false- True once deleted
user_idtext- The user's id
Example output
{
"deleted": true,
"user_id": "5678"
}Enterprise wipe device
Remove everything Workspace ONE put on a device (managed apps, profiles, email and data) and unenroll it, leaving personal data in place. For offboarding; it can't be undone. Workspace ONE queues it, and the device acts the next time it checks in.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
Outputs
commandtext- EnterpriseWipe
device_idtext- The device's id
queuedtrue/false- True once Workspace ONE has queued it for the device
Example output
{
"command": "EnterpriseWipe",
"device_id": "1234",
"queued": true
}Find device
Find one device by its serial number, UDID, Wi-Fi MAC address, IMEI or Exchange ActiveSync ID.
Inputs
- Find by
identifier_typetextRequired - Which identifier you have.One of:
Serialnumber(Serial number),Udid,Macaddress(Wi-Fi MAC address),ImeiNumber(IMEI),EasId(Exchange ActiveSync ID). - Identifier
identifiertextRequired - The device's serial number (or the identifier chosen).
Outputs
deviceobject- The device
Example output
{
"device": {
"AssetNumber": "A-1001",
"ComplianceStatus": "Compliant",
"CompromisedStatus": false,
"DeviceFriendlyName": "Jo Bloggs iPhone iOS 17.5 F2LXX",
"EnrollmentStatus": "Enrolled",
"Id": {
"Value": 1234
},
"Imei": "354833052322837",
"LastEnrolledOn": "2026-01-05T14:00:00",
"LastSeen": "2026-11-12T09:30:00",
"LocationGroupName": "Sales",
"MacAddress": "848506B900BA",
"Model": "iPhone 15",
"OperatingSystem": "17.5.1",
"Ownership": "C",
"Platform": "Apple",
"SerialNumber": "F2LXX1234567",
"Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
"UserEmailAddress": "jo@example.com",
"UserName": "jbloggs",
"Uuid": "6f1b5c1e-0c7e-4a3b-9a55-2d2e1f0c9b11",
"id": "1234"
}
}Get device
Get one device's details: its user, model, operating system, organization group, compliance and when it last checked in.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
Outputs
deviceobject- The device
Example output
{
"device": {
"AssetNumber": "A-1001",
"ComplianceStatus": "Compliant",
"CompromisedStatus": false,
"DeviceFriendlyName": "Jo Bloggs iPhone iOS 17.5 F2LXX",
"EnrollmentStatus": "Enrolled",
"Id": {
"Value": 1234
},
"Imei": "354833052322837",
"LastEnrolledOn": "2026-01-05T14:00:00",
"LastSeen": "2026-11-12T09:30:00",
"LocationGroupName": "Sales",
"MacAddress": "848506B900BA",
"Model": "iPhone 15",
"OperatingSystem": "17.5.1",
"Ownership": "C",
"Platform": "Apple",
"SerialNumber": "F2LXX1234567",
"Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
"UserEmailAddress": "jo@example.com",
"UserName": "jbloggs",
"Uuid": "6f1b5c1e-0c7e-4a3b-9a55-2d2e1f0c9b11",
"id": "1234"
}
}Get user
Get one enrollment user's details.
Inputs
- User
enrollment_user_idtextRequired - The enrollment user. Pick one of the newest 500, or give their id from an earlier step (such as 'Search users').
Outputs
userobject- The user
Example output
{
"user": {
"Department": "Sales",
"DisplayName": "Jo Bloggs",
"Email": "jo@example.com",
"EmployeeIdentifier": "E1001",
"EnrolledDevicesCount": "1",
"FirstName": "Jo",
"Group": "Sales",
"Id": {
"Value": 5678
},
"LastName": "Bloggs",
"LocationGroupId": "570",
"Role": "Full Access",
"SecurityType": "basic",
"Status": true,
"UserName": "jbloggs",
"Uuid": "0f6e1b75-50c4-4b04-84fe-dab5d2b7467a",
"id": "5678"
}
}Install app on device
Install an internal or public app on one device. Workspace ONE queues it, and the device acts the next time it checks in.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- App
apptextRequired - The app. Pick one, or give its id from 'Search apps' and choose its App type.
- App type
app_typetext - Only when App is a typed id: whether it is an internal or a public app.One of:
Internal(Internal (uploaded to Workspace ONE)),Public(Public (from an app store)).
Outputs
app_idtext- The app's id
app_typetext- internal or public
device_idtext- The device's id
queuedtrue/false- True once Workspace ONE has queued it for the device
Example output
{
"app_id": "88",
"app_type": "internal",
"device_id": "1234",
"queued": true
}Install profile on device
Install a device profile (Wi-Fi, email, restrictions...) on one device. Workspace ONE queues it, and the device acts the next time it checks in.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Profile
profile_idtextRequired - The profile. Pick one, or give its id from 'Search profiles'.
Outputs
device_idtext- The device's id
profile_idtext- The profile's id
queuedtrue/false- True once Workspace ONE has queued it for the device
Example output
{
"device_id": "1234",
"profile_id": "310",
"queued": true
}List device apps
List the apps on a device, managed or not, with versions. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
appslist- The apps
countnumber- How many are on this page
next_pagenumber- The next page's number, or 0 on the last page
pagenumber- This page's number, from 1
totalnumber- How many match in all
Example output
{
"apps": [
{
"ApplicationIdentifier": "com.air-watch.agent",
"ApplicationName": "Workspace ONE Intelligent Hub",
"IsManaged": true,
"Size": "120 MB",
"Status": "Installed",
"Type": "Public",
"Version": "24.06",
"id": "77"
}
],
"count": 1,
"next_page": 0,
"page": 1,
"total": 1
}List device notes
List the notes on a device's record.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
Outputs
countnumber- How many there are
noteslist- The notes
Example output
{
"count": 1,
"notes": [
{
"CreatedOn": "2026-11-12T09:30:00",
"DeviceId": 1234,
"Id": 55,
"ModifiedOn": "2026-11-12T09:30:00",
"Note": "Screen replaced under warranty.",
"id": "55"
}
]
}List smart group devices
List the devices in a smart group.
Inputs
- Smart group
smart_group_idtextRequired - The smart group. Pick one, or give its id from 'Search smart groups'.
Outputs
countnumber- How many there are
deviceslist- The devices
Example output
{
"count": 1,
"devices": [
{
"Id": "1234",
"Model": "iPhone 15",
"Name": "Jo Bloggs iPhone iOS 17.5 F2LXX",
"OSVersion": "17.5.1",
"Ownership": "C",
"Platform": "Apple",
"Username": "jbloggs",
"id": "1234"
}
]
}Lock device
Lock a device's screen, as for a lost device. Workspace ONE queues it, and the device acts the next time it checks in.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
Outputs
commandtext- Lock
device_idtext- The device's id
queuedtrue/false- True once Workspace ONE has queued it for the device
Example output
{
"command": "Lock",
"device_id": "1234",
"queued": true
}Move device to organization group
Move a device to another organization group, so it gets that group's profiles, apps and settings.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Organization group
organization_group_idtextRequired - The organization group to move it to.
Outputs
device_idtext- The device's id
movedtrue/false- True once Workspace ONE took it
organization_group_idtext- The organization group's id
Example output
{
"device_id": "1234",
"moved": true,
"organization_group_id": "570"
}Search apps
Find internal and public apps by name, type, platform or organization group, with how many devices have each. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name
nametext - Only apps with this name.
- App type
app_typetext - Only internal or public apps.One of:
Internal(Internal (uploaded to Workspace ONE)),Public(Public (from an app store)). - Platform
platformtext - Only this platform.One of:
Apple(iOS and iPadOS),AppleOsX(macOS),Android,WinRT(Windows). - Organization group
organization_group_idtext - Only in this organization group and those under it. Leave empty for the OAuth client's own.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
appslist- The apps
countnumber- How many are on this page
next_pagenumber- The next page's number, or 0 on the last page
pagenumber- This page's number, from 1
totalnumber- How many match in all
Example output
{
"apps": [
{
"AppType": "Internal",
"AppVersion": "3.2.0",
"ApplicationName": "Expenses",
"AssignedDeviceCount": 40,
"BundleId": "com.acme.expenses",
"Id": {
"Value": 88
},
"InstalledDeviceCount": 38,
"NotInstalledDeviceCount": 2,
"Platform": 2,
"Status": "Active",
"Uuid": "1d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a",
"id": "88"
}
],
"count": 1,
"next_page": 0,
"page": 1,
"total": 1
}Search devices
Find devices by user, model, platform, ownership, organization group, compliance or when they last checked in. Gets one page; to see more, run it again with the next page it gives.
Inputs
- User
usertext - Only devices enrolled by this username.
- Model
modeltext - Only this model, such as iPhone.
- Platform
platformtext - Only this platform.One of:
Apple(iOS and iPadOS),AppleOsX(macOS),Android,WinRT(Windows). - Ownership
ownershiptext - Only this ownership.One of:
C(Corporate - dedicated),S(Corporate - shared),E(Employee owned). - Organization group
organization_group_idtext - Only in this organization group and those under it. Leave empty for the OAuth client's own.
- Compliance
compliancetext - Only compliant, or only non-compliant, devices.One of:
true(Compliant),false(Not compliant). - Seen since
seen_sincedate and time - Only devices that checked in after this time.
- Order
sort_ordertext - Oldest first (by id) unless you choose newest first.One of:
ASC(Oldest first (default)),DESC(Newest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
countnumber- How many are on this page
deviceslist- The devices
next_pagenumber- The next page's number, or 0 on the last page
pagenumber- This page's number, from 1
totalnumber- How many match in all
Example output
{
"count": 1,
"devices": [
{
"AssetNumber": "A-1001",
"ComplianceStatus": "Compliant",
"CompromisedStatus": false,
"DeviceFriendlyName": "Jo Bloggs iPhone iOS 17.5 F2LXX",
"EnrollmentStatus": "Enrolled",
"Id": {
"Value": 1234
},
"Imei": "354833052322837",
"LastEnrolledOn": "2026-01-05T14:00:00",
"LastSeen": "2026-11-12T09:30:00",
"LocationGroupName": "Sales",
"MacAddress": "848506B900BA",
"Model": "iPhone 15",
"OperatingSystem": "17.5.1",
"Ownership": "C",
"Platform": "Apple",
"SerialNumber": "F2LXX1234567",
"Udid": "6bf0f04c73681fbecfc3eb4f13cbf05b",
"UserEmailAddress": "jo@example.com",
"UserName": "jbloggs",
"Uuid": "6f1b5c1e-0c7e-4a3b-9a55-2d2e1f0c9b11",
"id": "1234"
}
],
"next_page": 0,
"page": 1,
"total": 1
}Search organization groups
Find organization groups by name, type or Group ID. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name
nametext - Only organization groups with this name.
- Type
group_typetext - Only this type.One of:
Customer,Container,Partner. - Group ID
group_idtext - Only the one with this Group ID, the code users enroll with.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page's number, or 0 on the last page
organization_groupslist- The organization groups
pagenumber- This page's number, from 1
totalnumber- How many match in all
Example output
{
"count": 1,
"next_page": 0,
"organization_groups": [
{
"Country": "United States",
"CreatedOn": "2025-03-01T10:00:00",
"Devices": "25",
"GroupId": "acme-sales",
"Id": {
"Value": 570
},
"LocationGroupType": "Container",
"Name": "Sales",
"Users": "20",
"Uuid": "2c01c7c7-8a86-4b87-935f-8f219845cb4b",
"id": "570"
}
],
"page": 1,
"total": 1
}Search profiles
Find device profiles by name, platform, status or organization group. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name
search_texttext - Only profiles whose name has this text.
- Platform
platformtext - Only this platform.One of:
Apple(iOS and iPadOS),AppleOsX(macOS),Android,WinRT(Windows). - Status
statustext - Only active or inactive profiles.One of:
Active,Inactive. - Organization group
organization_group_idtext - Only in this organization group and those under it. Leave empty for the OAuth client's own.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page's number, or 0 on the last page
pagenumber- This page's number, from 1
profileslist- The profiles
totalnumber- How many match in all
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"profiles": [
{
"AssignmentType": "Auto",
"ManagedBy": "Acme",
"OrganizationGroupId": 570,
"Platform": "Apple",
"ProfileId": 310,
"ProfileName": "Corporate Wi-Fi",
"ProfileStatus": "Active",
"ProfileType": "Device",
"ProfileUuid": "c3a1f0d2-7b6e-4c5d-9e8f-1a2b3c4d5e6f",
"id": "310"
}
],
"total": 1
}Search smart groups
Find smart groups by name or organization group. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name
nametext - Only smart groups with this name.
- Organization group
organization_group_idtext - Only in this organization group and those under it. Leave empty for the OAuth client's own.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page's number, or 0 on the last page
pagenumber- This page's number, from 1
smart_groupslist- The smart groups
totalnumber- How many match in all
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"smart_groups": [
{
"Assignments": 3,
"Devices": 25,
"ManagedByOrganizationGroupId": "570",
"ManagedByOrganizationGroupName": "Sales",
"Name": "Sales iPhones",
"SmartGroupID": 42,
"SmartGroupUuid": "9a0d5c2e-1f6b-4d7e-8a3c-0b1e2f3a4b5c",
"id": "42"
}
],
"total": 1
}Search users
Find enrollment users by username, email, name, organization group or status. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Username
usernametext - Only this username.
- Email
emailtext - Only this email address.
- First name
first_nametext - Only this first name.
- Last name
last_nametext - Only this last name.
- Organization group
organization_group_idtext - Only in this organization group and those under it. Leave empty for the OAuth client's own.
- Status
statustext - Only active or inactive users.One of:
Active,Inactive. - Order
sort_ordertext - Oldest first (by id) unless you choose newest first.One of:
ASC(Oldest first (default)),DESC(Newest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 500. Workspace ONE's default is 500.From 1 to 500.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page's number, or 0 on the last page
pagenumber- This page's number, from 1
totalnumber- How many match in all
userslist- The users
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"total": 1,
"users": [
{
"Department": "Sales",
"DisplayName": "Jo Bloggs",
"Email": "jo@example.com",
"EmployeeIdentifier": "E1001",
"EnrolledDevicesCount": "1",
"FirstName": "Jo",
"Group": "Sales",
"Id": {
"Value": 5678
},
"LastName": "Bloggs",
"LocationGroupId": "570",
"Role": "Full Access",
"SecurityType": "basic",
"Status": true,
"UserName": "jbloggs",
"Uuid": "0f6e1b75-50c4-4b04-84fe-dab5d2b7467a",
"id": "5678"
}
]
}Send message to device
Send a notification to a device through Workspace ONE Intelligent Hub (as a text message if the device isn't enrolled).
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Message
messagetextRequired - What the notification says.
Outputs
device_idtext- The device's id
senttrue/false- True once Workspace ONE took it
Example output
{
"device_id": "1234",
"sent": true
}Sync or restart device
Ask a device to sync now, refresh its details in the console, or restart. Workspace ONE queues it, and the device acts the next time it checks in.
Inputs
- Device
device_idtextRequired - The device. Pick one of the newest 500, or give its id from an earlier step (such as 'Find device').
- Command
commandtextRequired - What the device should do.One of:
SyncDevice(Sync the device now),DeviceQuery(Refresh the device's details),SoftReset(Restart the device).
Outputs
commandtext- The command sent
device_idtext- The device's id
queuedtrue/false- True once Workspace ONE has queued it for the device
Example output
{
"command": "SyncDevice",
"device_id": "1234",
"queued": true
}Update user
Change an enrollment user's name, email, phone numbers, department or employee ID. Fields left empty stay as they are.
Inputs
- User
enrollment_user_idtextRequired - The enrollment user. Pick one of the newest 500, or give their id from an earlier step (such as 'Search users').
- First name
first_nametext - Their first name. Leave empty to keep it.
- Last name
last_nametext - Their last name. Leave empty to keep it.
- Email
emailtext - Their email address. Leave empty to keep it.
- Display name
display_nametext - The name shown for them. Leave empty to keep it.
- Phone number
phone_numbertext - Their phone number. Leave empty to keep it.
- Mobile number
mobile_numbertext - Their mobile number, for text messages. Leave empty to keep it.
- Department
departmenttext - Their department. Leave empty to keep it.
- Employee ID
employee_idtext - Their employee identifier. Leave empty to keep it.
Outputs
updatedlist- The fields sent, by Workspace ONE's names
user_idtext- The user's id
Example output
{
"updated": [
"Department",
"Email"
],
"user_id": "5678"
}