WS1API

Author(s)

• Phil Helmling

Tags

Workspace-ONE WS1 RestAPI API OAuth Authentication UEM Enterprise-Mobility Management Device-Management Application-Management Baseline-Management Agent-Management User-Management Enrollment Utilities MDM Mobile-Device-Management

Functions

Add-DeviceTag Clear-DevicePasscode Compare-EnrollmentSID Disable-EnrollmentNotifications Enable-EnrollmentNotifications Get-AgentInstallInfo Get-App Get-Baseline Get-BaselineAssignments Get-BaselineSummary Get-BaselineTemplate Get-CurrentLoggedonUser Get-DeviceEnrollmentStatus Get-DeviceNotes Get-DevicePoliciesInBaseline Get-DevicesByCustomAttribute Get-Devices Get-DevicesInBaseline Get-DeviceTags Get-DuplicateDevices Get-DuplicateUsers Get-Enrollment Get-EnrollmentInfoWithPolling Get-Log Get-NewDeviceId Get-OG Get-ProblematicDevices Get-RegistryValue Get-ReverseSID Get-ServerAuth Get-StaleDevices Get-UserSIDLookup Get-WSONEOAuthToken Install-Agent Invoke-AgentCleanup Invoke-AWApiCommand Invoke-ChunkandUpload Invoke-CreateTask Invoke-DownloadAirwatchAgent Invoke-DownloadApp Invoke-DownloadAppBlob Invoke-OGSearch Invoke-RestMethodWithRetry Invoke-SmartGroupCommand Invoke-UploadfromLink New-AppIcon New-Application New-Tag Remove-Agent Remove-Devices Remove-DeviceTag Remove-DuplicateUsers Show-Toast Update-DeviceProperty Wait-AppsInstalled Wait-ProfilesInstalled Write-2Report Write-Log

Dependencies

This module has no dependencies.

Release Notes

1.2.0 Release Notes:

AUTHENTICATION & CONFIGURATION (5 functions):
   - Get-ServerAuth - Prompt for or accept server authentication credentials
   - Get-WSONEOAuthToken - Retrieve OAuth access token with Bearer format
   - Invoke-AWApiCommand - Execute RestAPI commands against WS1 UEM
   - Invoke-RestMethodWithRetry - Invoke REST methods with exponential backoff retry logic
   - Get-OG - Retrieve Organization Groups from WS1 UEM
   
   ORGANIZATION & SEARCH (2 functions):
   - Invoke-OGSearch - Search for OG and prompt user to select from results
   - Get-Enrollment - Retrieve detailed WS1 enrollment info from device registry
   
   DEVICE DISCOVERY (6 functions):
   - Get-Devices - Recursive pagination for all devices
   - Get-StaleDevices - Identify devices not seen in N days (default 90)
   - Get-DuplicateDevices - Find duplicate devices by serial number with KeepNewest filter
   - Get-ProblematicDevices - Detect devices with invalid/placeholder serial numbers
   - Get-NewDeviceId - Retrieve device ID from WS1 UEM based on serial number
   - Get-DevicesByCustomAttribute - Search devices by custom attribute name and values
   
   DEVICE MANAGEMENT (11 functions):
   - Add-DeviceTag - Apply tags to devices
   - Remove-DeviceTag - Remove tags from devices
   - Get-DeviceTags - Retrieve tags from organization group
   - Get-DeviceEnrollmentStatus - Check device enrollment status
   - Disable-EnrollmentNotifications - Disable enrollment activity notifications for device
   - Enable-EnrollmentNotifications - Enable enrollment activity notifications for device
   - Remove-Devices - Bulk delete devices via /api/mdm/devices/bulk with confirmation
   - Get-DeviceNotes - Retrieve console notes for devices
   - Update-DeviceProperty - Update device properties (FriendlyName, AssetNumber)
   - Clear-DevicePasscode - Bulk clear device passcodes with confirmation
   - Invoke-SmartGroupCommand - Execute commands on smart group devices

   APPLICATIONS (7 functions):
   - Get-App - Search or list UEM applications by name, group, and/or platform, with automatic pagination
   - New-AppIcon - Upload app icons with BlobId return
   - New-Application - Create internal apps with platform validation (BundleId mandatory)
   - Invoke-DownloadAppBlob - Download internal app icon/package blob using blob UUID
   - Invoke-DownloadApp - Find an app by name (prompting on multiple matches) and download its blob
   - Invoke-ChunkandUpload - Handle large file uploads with chunking
   - Invoke-UploadfromLink - Upload application from external URL
   
   BASELINES (6 functions):
   - Get-Baseline - Retrieve baseline templates
   - Get-BaselineTemplate - Get baseline template details
   - Get-DevicesInBaseline - Query devices assigned to baseline
   - Get-DevicePoliciesInBaseline - Get policy details assigned to baseline
   - Get-BaselineAssignments - Retrieve baseline assignment information
   - Get-BaselineSummary - Get summary statistics for baseline deployments
   
   AGENT MANAGEMENT (7 functions):
   - Get-AgentInstallInfo - Check Workspace ONE agent installation status
   - Install-Agent - Install and enroll the WS1 Hub agent
   - Remove-Agent - Uninstall the WS1 Hub agent
   - Invoke-DownloadAirwatchAgent - Download agent installer from UEM server
   - Invoke-AgentCleanup - Remove Workspace ONE Agent and artifacts
   - Wait-AppsInstalled - Wait for assigned apps to install on device
   - Wait-ProfilesInstalled - Wait for assigned profiles to install on device
   
   USER MANAGEMENT & ENROLLMENT (5 functions):
   - Get-CurrentLoggedonUser - Get currently logged-on user on local system
   - Get-UserSIDLookup - Translate username to Security Identifier (SID)
   - Get-ReverseSID - Translate SID to username or group name
   - Compare-EnrollmentSID - Compare current user SID with enrollment SID
   - Get-EnrollmentInfoWithPolling - Poll UEM API for device enrollment info with retries
   - Get-DuplicateUsers - Find duplicate user accounts
   - Remove-DuplicateUsers - Delete duplicate user accounts with confirmation
   
   LOCAL SYSTEM & UTILITIES (4 functions):
   - Get-RegistryValue - Query Windows registry values
   - Invoke-CreateTask - Create scheduled task for automation
   - Show-Toast - Display Windows toast notification to user
   - New-Tag - Create new tag in organization group
   
   LOGGING & REPORTING (3 functions):
   - Get-Log - Retrieve and parse log files
   - Write-Log - Write timestamped, color-coded log messages to file and console
   - Write-2Report - Generate formatted report output with decorative borders