Rest APIs require authentication to integrate with Workspace ONE UEM. Prior to authentication, API access must be enabled in the Workspace ONE UEM console. This page is used to configure the settings required for REST APIs.

What can you do with Workspace ONE UEM Rest API Settings

To access the Rest API Settings navigate to Groups & Settings > All Settings > System > Advanced > API > REST API.

  • Enable API access

Determine your Organization group hierarchy

Before you review and modify the settings, understand the two types of inheritance/override options for the organization group hierarchy available at the top and bottom of the settings page and determine your choice. For more information about these settings, see Override Versus Inherit Setting for Organization Groups.
  • Current Setting – Select whether to Inherit or Override the displayed settings. Inherit means use the settings of the current organization group's parent OG, while Override enables the settings for editing so you can modify the current OG's settings directly.
  • Child Permission – Select the available behavior of child organization groups that exist below the currently selected organization group. Inherit only means child OGs are only allowed to inherit these settings. Override only means they override the settings, and Inherit or Override means you can choose to inherit or override settings in child OGs that exist below the currently selected OG.

General Tab

For on-premise customers, you may need to restart IIS on the API servers in order to get this these settings to apply properly.

Setting Description
Enable API Access Select Enable API Access for APIs to integrate with Workspace ONE UEM. APIs get authenticated (either basic authentication or directory authentication) to integrate Workspace ONE UEM only if this check box is enabled.
Add

Select Add to add/or generate multiple API keys.

  • Service – Enter one or multiple service(s) and generate their own independent API keys.
  • Account Type – Select the type of the account. To access Personal Content APIs (MCM APIs), select the Account type as Enrollment User.
  • API Key – Read-only key generated when you select the Add button.
  • Description – Enter short description for the service and generated API key.
  • Whitelisted Domains – Enter domains that can interact with Workspace ONE UEM APIs through the API key.
  • Admin Generated? – Displays which API keys were automatically generated and which were manually generated for different integrations.

Authentication Tab

Setting Description
Basic Select basic access for authentication using basic credentials (username and password). Credentials only exist in Workspace ONE UEM and do not necessarily match the existing corporate credentials. It requires no technical integration and no enterprise infrastructure.
Certificates Certificate-based API authentication is utilized to provide the API access to the admin users. Utilizing this method, a self-signed, user-level API certificate must be generated from the Workspace ONE UEM console.
Note: Disabling certificate based authentication breaks any existing integration with other services that rely upon it such as GreenBox, Access (formerly vIDM), Tunnel, Tunnel Proxy, SEG, and so forth, causing those services to fail. If you want to remove certificate based authentication, you must first make certain that no running service depends upon it.
Directory Select directory access of authentication if you want to integrate user and admin accounts of Workspace ONE UEM with existing corporate accounts. End users now authenticate with existing corporate credentials.

Usage Tab

Setting Description
Server Throttling

Set the server bandwidth throttling (calls per minute). When the server reaches the specified throttling limit, it offloads new requests and does not respond to them. The default value is 5,000.

If you set the calls-per-minute to 0, the throttling is turned off and you can make an unlimited number of API calls.
Daily Quota
Set the number of API calls to be sent per day. The default value is 50,000. If your calls-per-day is 0, no API calls connect.
Note: Increasing the maximum value can potentially lead to the server performance issue. Contact Workspace ONE support if needed.
Daily Quota Usage Specifies the number of the API calls used out of the daily quota set for the API calls.