|
| 1 | +--- |
| 2 | +id: zimperium-mtd-source |
| 3 | +title: Zimperium MTD Source |
| 4 | +sidebar_label: Zimperium MTD |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - zimperium-mtd |
| 8 | +description: Learn how to collect the device logs from the Zimperium API and send it to Sumo Logic. |
| 9 | +--- |
| 10 | + |
| 11 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 12 | + |
| 13 | +<img src={useBaseUrl('img/send-data/zimperium-mtd.png')} alt="logo" width="60" /> |
| 14 | + |
| 15 | +Zimperium is a cybersecurity company specializing in mobile threat defense. It uses machine learning and on-device detection to deliver real-time protection against mobile device, network, phishing, and app threats. Designed for enterprises, its solutions safeguard sensitive data and ensure mobile security and integrity without compromising user experience or privacy in an increasingly mobile-first world. |
| 16 | + |
| 17 | +## Data collected |
| 18 | + |
| 19 | +The data will be collected from Zimperium MTD's database using the following log: |
| 20 | + |
| 21 | +| Polling Interval | Data | |
| 22 | +| :--- | :--- | |
| 23 | +| 12 hours | [Device Logs](https://zc202.zimperium.com/login?redirect=/ziap-docs/zips-docs/api/api_details_device.html) | |
| 24 | + |
| 25 | +## Setup |
| 26 | + |
| 27 | +### Vendor configuration |
| 28 | + |
| 29 | +The Zimperium MTD source requires you to provide the **Account URL**, **Client ID**, and **Client Secret** to set up the integration. |
| 30 | + |
| 31 | +#### Account URL |
| 32 | + |
| 33 | +The Account URL is the Base URL used to retrieve the source data from the Zimperium device log API. For example, `https://{subdomain}.zimperium.com` |
| 34 | + |
| 35 | +#### Client ID and Client Secret |
| 36 | + |
| 37 | +Follow the steps below to generate the Client Id and Client Secret: |
| 38 | + |
| 39 | +1. Log in to the Zimperium portal and navigate to **API Keys**. |
| 40 | +1. From the API Keys page, select **Add Partner API Key** to create a new API key. |
| 41 | +1. Enter the **API Key Description** and select **Save API Access** to obtain the Client ID and Client Secret credentials. |
| 42 | + |
| 43 | +Once you have all the required values, set up the source configuration to collect your desired log types available in the configuration section. |
| 44 | + |
| 45 | +### Source configuration |
| 46 | + |
| 47 | +When you create a Zimperium MTD 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). |
| 48 | + |
| 49 | +To configure a Zimperium MTD source: |
| 50 | +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**. |
| 51 | +1. On the Collection page, click **Add Source** next to a Hosted Collector. |
| 52 | +1. Search for and select **Zimperium MTD**. |
| 53 | +1. Enter a **Name** for the Source. The description is optional. |
| 54 | +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`. |
| 55 | +1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value. |
| 56 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 57 | + *  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 it is ignored, known as dropped. |
| 58 | +1. **Account URL**. Enter your [Account URL](#vendor-configuration). |
| 59 | +1. **Client ID**. Enter your [Client ID](#vendor-configuration). |
| 60 | +1. **Client Secret**. Enter your [Client Secret](#vendor-configuration). |
| 61 | +1. **Polling Interval**. The polling interval is set for 12 hours by default and can be configured to a maximum of 24 hours. You can adjust it based on your needs. This sets how often the source checks for new data. |
| 62 | +1. **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). |
| 63 | +1. When you are finished configuring the source, click **Save**. |
| 64 | + |
| 65 | +## JSON schema |
| 66 | + |
| 67 | +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. |
| 68 | + |
| 69 | +| Parameter | Type | Value | Required | Description | |
| 70 | +|:--|:--|:--|:--|:--| |
| 71 | +| schemaRef | JSON Object | `{“type”: “Zimperium MTD”} for Zimperium MTD Source` | Yes | Define the specific schema type. | |
| 72 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 73 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 74 | + |
| 75 | +### Configuration Object |
| 76 | + |
| 77 | +| Parameter | Type | Required | Default | Description | Example | |
| 78 | +|:--|:--|:--|:--|:--|:--| |
| 79 | +| 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"` | |
| 80 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` | |
| 81 | +| 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"` |
| 82 | +| 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"}` | |
| 83 | +| accountURL | String | Yes | `null` | The base URL to fetch the data from the Zimperium Device log API. | `https://{subdomain}.zimperium.com` | |
| 84 | +| clientId | String | Yes | `null` | The client identifier is given within the Console user interface. | | |
| 85 | +| clientSecret | String | Yes | `null` | The client secret is given within the Console user interface. | | |
| 86 | +| pollingInterval | Integer | Yes | `12 hours` | Time interval (in hours) after which the source will check for new data. | | |
| 87 | + |
| 88 | +### JSON example |
| 89 | + |
| 90 | +```json reference |
| 91 | +https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/zimperium-mtd/example.json |
| 92 | +``` |
| 93 | + |
| 94 | +### Terraform example |
| 95 | + |
| 96 | +```sh reference |
| 97 | +https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/zimperium-mtd/example.tf |
| 98 | +``` |
| 99 | + |
| 100 | +## FAQ |
| 101 | + |
| 102 | +:::info |
| 103 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 104 | +::: |
0 commit comments