Back to top

Prerequisites for connecting to VMware

Last updated July 26th, 2023

This section describes prerequisite steps you need to perform before you can start connecting to VMware.

To connect to VMware, you need:

  • A VMware account
  • A REST API key in VMware

Create a REST API key in VMware

If you use VMware as your EMM, you must enable REST API access and create an API key for Knox E-FOTA. You will then use the generated API key to connect to VMware through the Knox E-FOTA console.

To create a REST API key

  1. Sign in to the VMware console.

  2. Go to Groups & Settings > All Settings > System > Advanced > API > Rest API.

  3. Go to the General tab.

  4. Beside Enable API Access, click Enabled.

  5. Click Add. A REST API key is generated.

    vmware get api key

  6. Copy the generated REST API key to a file and save it. You can use this key with Knox E-FOTA.

  7. Under Service, enter a unique name for the API key. Example: AirWatchAPI.

  8. Under Account Type, select Admin.

  9. Under Description, describe the purpose of the API key. Example: AirWatchAPI for Knox E-FOTA.

  10. Click Save.

Generate client ID and client secret

If you’d like to authenticate using OAuth authentication, you must have a client ID and client secret as well. To generate your Client ID and Client secret:

  1. Sign in to the VMware console.
  2. Click Groups & Settings > Configurations.
  3. Enter OAuth in the Enter a name or category field.
  4. Select OAuth Client Management > Add.
  5. Enter the Name, Description, Organization Group, and Role.
  6. Toggle the Status switch to Enabled.
  7. Click Save.

vmware oauth authentication prerequisites

Is this page helpful?