- 30 Sep 2024
- 5 Minutes to read
- Print
- DarkLight
- PDF
VMware Workspace ONE (AirWatch)
- Updated on 30 Sep 2024
- 5 Minutes to read
- Print
- DarkLight
- PDF
VMWare Workspace ONE (formerly AirWatch) provides enterprise mobility management (EMM) software and standalone management systems for content, applications, and email.
Types of Assets Fetched
This adapter fetches the following types of assets:
- Devices
- Users
- Software
- SaaS Applications
Parameters
AirWatch Domain - The hostname or IP address of the VMWare Workspace ONE server.
Authentication Method - Select an authentication method, either OAuth or User Credentials. If you select User Credentials, then User Name and Password are displayed. If you select OAuth, then Client ID, Client Secret and Access Token Domain are displayed
User Credentials
User Name and Password - The credentials for a user account that has the permissions to fetch assets.
Note:If a user name is a dedicated user created solely for the adapter usage, you must first login as that user to create the recovery key. Once completed, connection with the adapter should be successful.
API Key - API key for the REST API, created in the admin panel. For more details, see Creating an API Key for the VMware Workspace ONE (AirWatch).
OAuth
Client ID and Client Secret - When you choose OAuth as the authentication method, specify the Client ID and Client Secret to be used to authenticate the request. For more information about obtaining a Client ID and Client Secret refer to How to Use REST API in Workspace ONE UEM .
Access Token Domain - The Token Issuer domain. Refer to Access Token URLs for information about the Access Token URL. The optional Access Token Domains are 'apac', 'emea', 'na' or 'uat'.
API Rate Limit (Calls per Minute) (optional) - Specify a rate limit for the number of requests per minute to be sent to VMware. If left empty, the number of requests initiated by the connection for this adapter won't be limited.
Verify SSL - Select whether to verify the SSL certificate offered by the value supplied in AirWatch Domain. For more details, see SSL Trust & CA Settings.
HTTPS Proxy (optional) - A proxy to use when connecting to the value supplied in AirWatch Domain.
HTTPS Proxy User Name (optional) - The user name to use when connecting to the value supplied in AirWatch Domain via the value supplied in HTTPS Proxy.
HTTPS Proxy Password (optional) - The password to use when connecting to the value supplied in AirWatch Domain via the value supplied in HTTPS Proxy.
For details on the common adapter connection parameters and buttons, see Adding a New Adapter Connection.
Advanced Settings
Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to Advanced Configuration for Adapters
- Async chunks (required, default: 50) - Specify the number of parallel requests all connections for this adapter will send to the VMWare Workspace ONE server in parallel at any given point.
- Page Size (required, default: 500) - Set the number of results per page received for a given query to the VMWare Workspace ONE server, to gain better control on the performance of all connections of for this adapter.
- Socket recv session timeout (required, default: 300) - Specify how many seconds all connections for this adapter will wait for a response before considering the request as timed out.
- Fetch devices not enrolled (required, default: True) - Select whether to fetch devices that are not enrolled from VMWare Workspace ONE server.
- If enabled, all connections for this adapter will also fetch devices that are not enrolled.
- If disabled, all connections for this adapter will not fetch devices that are not enrolled.
- Fetch extended information *(required, default: true) - Select whether to fetch additional information for each device, such as the Security Patch Date field.
- If enabled, all connections for this adapter will also fetch additional information for each device.
- If disabled, all connections for this adapter will not fetch additional information for each device.
- Fetch device apps (required, default: true) - Select whether to fetch additional information for each device application from VMWare Workspace ONE server.
- If enabled, all connections for this adapter will also fetch applications associated with the fetched devices.
- If disabled, all connections for this adapter will not fetch application data.
- Fetch device networks (required, default: true) - Select whether to fetch device networks from VMWare Workspace ONE server.
- If enabled, all connections for this adapter will also fetch networks data associated with the fetched devices.
- If disabled, all connections for this adapter will not fetch networks data.
- Fetch device notes (required, default: true) - Select whether to fetch device notes from VMWare Workspace ONE server.
- If enabled, all connections for this adapter will also fetch notes associated with the fetched devices.
- If disabled, all connections for this adapter will not fetch notes.
- Fetch device tags (required, default: true) - Select whether to fetch device tags from VMWare Workspace ONE server.
- If enabled, all connections for this adapter will also fetch tags associated with the fetched devices.
- If disabled, all connections for this adapter will not fetch tags.
- Fetch device profiles (required, default: true) - Select whether to fetch device profiles from VMWare Workspace ONE server.
- If enabled, all connections for this adapter will also fetch profiles associated with the fetched devices.
- If disabled, all connections for this adapter will not fetch profiles.
- Only fetch installed software (optional, default: false) - Select whether to only fetch installed software.
- If selected, only software with a Status of '2' (Installed) will be included in the fetch.
- If disabled, all software listed under devices will be fetched, regardless of status.
- Fetch device compliance data (required, default: true) - Select to query the compliance API. If this option is clear, the device compliance API is not queried and related data is not fetched.
- Fetch device sensors information - Select this option to fetch device sensor information.
- Fetch baselines - Select this option to fetch baselines based on the organizational group the adapter finds. A "Baselines" column will be added to each device and you will be able to run queries on it, if required.
- Fetch security search information - Select this option to fetch security information for a device.
- Fetch extensive search - Select this option to search results containing the devices and their product assignment information and fetch that data.
- Fetch users (default: true) - Select this option to fetch users (if you clear this option, users are not fetched).
- Fetch Smart Groups - Select this option to fetch Smart Groups.
For details on general advanced settings under the Adapter Configuration tab, see Adapter Advanced Settings.
Creating an API Key for the VMware Workspace ONE (AirWatch) API
To create an API key for the VMware Workspace ONE (AirWatch) API:
Go to the admin panel, click on Groups & Setting and then click on All Settings:
After clicking, you will see a screen with new options to your left.
Click: System → Advanced → API → REST API. You will see this screen:Click add to create a new API key, add an indicative service name, set it to admin Account Type , copy the API key and save it to a secure location (you will need it later on when configuring the adapter).