You can configure external applications to use the core product functionality of Workspace ONE UEM by integrating REST APIs with the UEM infrastructure and facilitate connectivity. You can also select an OAuth token URL closest to your datacenter to authenticate API calls.

Getting Started with REST APIs

Using simplified REST software architecture, Workspace ONE UEM REST APIs currently support multiple functionalities, including organization group, console administration, mobile application, mobile device, email, enrollment user, profile, smart group, and user group management.

Using REST-based APIs provide several benefits to enterprises, including eliminated cost and time spent developing applications in-house. Workspace ONE UEM REST APIs are fully able and ready to integrate with enterprise servers, programs, and processes. Additionally, Workspace ONE UEM REST APIs are more efficient, can run smoothly and can be easily branded with enterprises. These APIs are intended for application developers, and this guide provides an understanding of design and architecture of the API library to facilitate custom development and integration with Workspace ONE UEM.

Access API Documentation

Access detailed API documentation by navigating to the Workspace ONE UEM API Help page.

Do this in SaaS environments by replacing the "cn" in your URL with "as" and then append /api/help after .com.

For example, API documentation for a SaaS environment's URL
https://cn4855.awmdm.com
is
https://as4855.awmdm.com/api/help

Datacenter and Token URLs for OAuth 2.0 Support

Workspace ONE UEM supports the OAuth 2.0 industry standard protocol for secure authentication and authorization for REST API calls.

The Token URLs are region-specific.

Table 1. Region-Specific Token URLs
Region Workspace ONE UEM SaaS Data Center Location Token URL
Ohio (United States) All UAT environment https://uat.uemauth.vmwservices.com/connect/token
Virginia (United States) United States https://na.uemauth.vmwservices.com/connect/token
Virginia (United States) Canada https://na.uemauth.vmwservices.com/connect/token
Frankfurt (Germany) United Kingdom https://emea.uemauth.vmwservices.com/connect/token
Frankfurt (Germany) Germany https://emea.uemauth.vmwservices.com/connect/token
Tokyo (Japan) India https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japan) Japan https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japan) Singapore https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japan) Australia https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japan) Hong Kong https://apac.uemauth.vmwservices.com/connect/token

Create an OAuth Client to Use for API Commands

You can create an OAuth client to use for API commands in the Workspace ONE UEM console version 2001 or later. Create an OAuth client by taking the following steps.

  1. Navigate to Groups & Settings > Configurations.
  2. Enter OAuth in the search text box labeled 'Enter a name or category'.
  3. Select OAuth Client Management that appears in the results. The OAuth Client Management screen displays.
  4. Select the Add button.
  5. Enter the Name, Description, Organization Group, and Role.
  6. Ensure that the Status is Enabled.
  7. Select Save.
  8. IMPORTANT: Copy the Client ID and Client Secret to clipboard and save them before you close this screen. Select the clipboard icon () to send the Client Secret to the clipboard.

    You cannot return here to retrieve these pieces of information after you select Close.