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.

General Tab

  • 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.
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.
  • Description – Enter short description for the service and generated API key.
  • Whitelisted Domains – Enter domains that can interact with Workspace ONE UEM APIs via API key.
  • 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.

Authentication Tab

  • 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.
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.
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.
  • 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.

Advanced Tab

Setting Description
Server Throttling

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

If you set the calls-per-minute to 0, no API calls will connect.

Daily Quota

Set the number of API calls to be sent per day. The maximum value available is 2,000,000,000 (2 billion).

If you set the calls-per-day to 0, no API calls will connect.