|
| 1 | +--- |
| 2 | +id: vmware-workspace-one-source |
| 3 | +title: VMware Workspace One Source |
| 4 | +sidebar_label: VMware Workspace One |
| 5 | +tags: |
| 6 | + - vmware-workspace-one |
| 7 | +description: Collect the device details and corresponding list of applications for the devices from the VMware Workspace One platform. |
| 8 | +--- |
| 9 | +import CodeBlock from '@theme/CodeBlock'; |
| 10 | +import ExampleJSON from '/files/c2c/vmware-workspace-one/example.json'; |
| 11 | +import MyComponentSource from '!!raw-loader!/files/c2c/vmware-workspace-one/example.json'; |
| 12 | +import TerraformExample from '!!raw-loader!/files/c2c/vmware-workspace-one/example.tf'; |
| 13 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 14 | + |
| 15 | +<img src={useBaseUrl('img/send-data/vmware_workspace_one.png')} alt="vmware-workspace-one-logo" width="60" /> |
| 16 | + |
| 17 | +VMware Workspace ONE is a comprehensive digital workspace platform that combines unified endpoint management, access management, and application management capabilities. It enables organizations to securely deliver and manage any app on any device, providing a seamless and productive user experience. Workspace ONE empowers IT teams to simplify device management, enhance security, and increase workforce productivity through a unified and integrated process. |
| 18 | + |
| 19 | + |
| 20 | +The VMware Workspace One source collects the device details and corresponding list of applications for the devices from the VMware Workspace One platform and send them to Sumo Logic. |
| 21 | + |
| 22 | +## Data collected |
| 23 | + |
| 24 | +| Polling Interval | Data | |
| 25 | +| :--- | :--- | |
| 26 | +| 24 hours | [Devices](https://cn135.awmdm.com/API/help/Docs/Explore?urls.primaryName=MDM%20API%20V3#/DevicesV3/DevicesV3_SearchAsync) | |
| 27 | +| 24 hours | [Device Applications](https://cn135.awmdm.com/API/help/Docs/Explore?urls.primaryName=MDM%20API%20V2#/AppsV2/AppsV2_GetAppListForDevicesAsync) | |
| 28 | + |
| 29 | +## Setup |
| 30 | + |
| 31 | +### Vendor configuration |
| 32 | + |
| 33 | +The VMware Workspace One source supports [O-Auth-based authentication](https://docs.omnissa.com/bundle/WorkspaceONE-UEM-Console-BasicsVSaaS/page/UsingUEMFunctionalityWithRESTAPI.html#create_an_oauth_client_to_use_for_api_commands_saas) and requires you to provide the **Endpoint URL**, **Auth URL**, **Client ID**, and **Client Secret** key to access the data. |
| 34 | + |
| 35 | +#### Endpoint URL |
| 36 | + |
| 37 | +Endpoint URL will be the domain URL of the VMware Workspace console. For example, `https://as135.awmdm.com`. |
| 38 | + |
| 39 | + |
| 40 | +#### Auth URL |
| 41 | + |
| 42 | + |
| 43 | +The following table contains the Auth URLs based on the location of your VMware Workspace One API account: |
| 44 | + |
| 45 | +| Region | Auth URL | |
| 46 | +|:--|:--| |
| 47 | +| All UAT Environment | `https://uat.uemauth.vmwservices.com/connect/token` | |
| 48 | +| Australia | `https://apac.uemauth.vmwservices.com/connect/token` | |
| 49 | +| Canada | `https://na.uemauth.vmwservices.com/connect/token` | |
| 50 | +| Germany | `https://emea.uemauth.vmwservices.com/connect/token` | |
| 51 | +| Hong Kong | `https://apac.uemauth.vmwservices.com/connect/token` | |
| 52 | +| India | `https://apac.uemauth.vmwservices.com/connect/token` | |
| 53 | +| Japan | `https://apac.uemauth.vmwservices.com/connect/token` | |
| 54 | +| Singapore | `https://apac.uemauth.vmwservices.com/connect/token` | |
| 55 | +| United Kingdom | `https://emea.uemauth.vmwservices.com/connect/token` | |
| 56 | +| United States | `https://na.uemauth.vmwservices.com/connect/token` | |
| 57 | + |
| 58 | +#### Client ID and Client Secret |
| 59 | + |
| 60 | +To generate the Client ID and Client Secret, refer to the [Create an OAuth Client to Use for API Commands (SaaS)](https://docs.omnissa.com/bundle/WorkspaceONE-UEM-Console-BasicsVSaaS/page/UsingUEMFunctionalityWithRESTAPI.html#create_an_oauth_client_to_use_for_api_commands_saas) section. |
| 61 | + |
| 62 | +### Source configuration |
| 63 | + |
| 64 | +When you create a VMware Workspace One Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector). |
| 65 | + |
| 66 | +To configure a VMware Workspace One Source: |
| 67 | +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. |
| 68 | +1. On the Collection page, click **Add Source** next to a Hosted Collector. |
| 69 | +1. Search for and select **VMware Workspace One**. |
| 70 | +1. Enter a **Name** for the Source. The description is optional. |
| 71 | +1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`. |
| 72 | +1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value. |
| 73 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 74 | + *  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema is ignored, known as dropped. |
| 75 | +1. **Endpoint URL**. Enter the [VMware Workspace One platform](#vendor-configuration) endpoint URL. For example, `https://as135.awmdm.com`. |
| 76 | +1. **Auth URL**. Enter the API region URL to fetch the auth token collected from the [VMware Workspace One platform](#auth-url). For example, `https://uat.uemauth.vmwservices.com`. |
| 77 | +1. **Client ID**. Enter the Client ID of your account collected from the [VMware Workspace One platform](#client-id-and-client-secret). For example, `cfea26d59bd542488ea706b025564d42`. |
| 78 | +1. **Client Secret**. Enter the Client Secret key of your account collected from the [VMware Workspace One platform](#client-id-and-client-secret). For example, `E2220271xxxxxxxxxxxxxxxxxxxxx4556634`. |
| 79 | +1. (Optional) **Device Type**. Enter the list of device types to collect information. |
| 80 | +1. Select the **Collect Apps Details** checkbox to collect the apps details. |
| 81 | +1. When you are finished configuring the Source, click **Submit**. |
| 82 | + |
| 83 | +## JSON schema |
| 84 | + |
| 85 | +Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. |
| 86 | + |
| 87 | +| Parameter | Type | Value | Required | Description | |
| 88 | +|:--|:--|:--|:--|:--| |
| 89 | +| schemaRef | JSON Object | `{"type":"VMware Workspace One"}` | Yes | Define the specific schema type. | |
| 90 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 91 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 92 | + |
| 93 | +### Configuration Object |
| 94 | + |
| 95 | +| Parameter | Type | Required | Default | Description | Example | |
| 96 | +|:--|:--|:--|:--|:--|:--| |
| 97 | +| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` | |
| 98 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` | |
| 99 | +| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` | |
| 100 | +| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the collector or source. Use the boolean field `_siemForward` to enable forwarding to SIEM.| `{"_siemForward": false, "fieldA": "valueA"}` | |
| 101 | +| requestEndpoint | String | Yes | `null` | The base URL to fetch the data from the VMware Workspace One source. | `https://as135.awmdm.com` | |
| 102 | +| authURL | String | Yes | `null` | The API URL to fetch the authentication token from the VMware Workspace One source. | `https://uat.uemauth.vmwservices.com` | |
| 103 | +| clientID | String | Yes | `null` | Client ID of your account. | `cfea26d59bd542488ea706b025564d42` | |
| 104 | +| clientSecret | String | Yes | `null` | Client Secret of your account. | `E2220271xxxxxxxxxxxxxxxxxxxxx4556634` | |
| 105 | +| deviceType | String | No | `null` | Platform type of the device. | `Apple, Android, and/or WindowsPC` | |
| 106 | +| pollingIntervalVulnerabilityMin | String | Yes | `24 hours` | Time interval (in minutes) after which the source will check for new data.<br/>**Default**: 24 hours<br/>**Minimum**: 12 hours<br/>**Maximum**: 24 hours | | |
| 107 | +| collectAppsDetails | Boolean | No | `False` | Specify if you need to collect the app details. | | |
| 108 | + |
| 109 | +### JSON example |
| 110 | + |
| 111 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 112 | + |
| 113 | +<a href="/files/c2c/vmware-workspace-one/example.json" target="_blank">Download example</a> |
| 114 | + |
| 115 | +### Terraform example |
| 116 | + |
| 117 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 118 | + |
| 119 | +<a href="/files/c2c/vmware-workspace-one/example.tf" target="_blank">Download example</a> |
| 120 | + |
| 121 | +## FAQ |
| 122 | + |
| 123 | +:::info |
| 124 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 125 | +::: |
0 commit comments