|
| 1 | +--- |
| 2 | +id: kandji-source |
| 3 | +title: Kandji Source |
| 4 | +sidebar_label: Kandji |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - kandji-edr |
| 8 | +description: The Kandji Source provides a secure endpoint to receive threat details, devices list, device activities, and device details from the Kandji platform. |
| 9 | +--- |
| 10 | +import CodeBlock from '@theme/CodeBlock'; |
| 11 | +import ExampleJSON from '/files/c2c/kandji/example.json'; |
| 12 | +import MyComponentSource from '!!raw-loader!/files/c2c/kandji/example.json'; |
| 13 | +import TerraformExample from '!!raw-loader!/files/c2c/kandji/example.tf'; |
| 14 | +import ForwardToSiem from '/docs/reuse/forward-to-siem.md'; |
| 15 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 16 | + |
| 17 | +<img src={useBaseUrl('img/send-data/kandji-logo.png')} alt="icon" width="50"/> |
| 18 | + |
| 19 | +Kandji is the Apple device management and security platform that empowers secure and productive global work. With Kandji, Apple devices transform themselves into enterprise-ready endpoints, with all the right apps, settings, and security systems in place. Through advanced automation and thoughtful experiences, Kandji brings much-needed harmony to the way IT, InfoSec, and Apple device users work. |
| 20 | + |
| 21 | +## Data collected |
| 22 | + |
| 23 | +| Polling Interval | Data | |
| 24 | +| :--- | :--- | |
| 25 | +| 5 min | [Threat Details](https://api-docs.kandji.io/#d041043a-ea47-47d5-b6f1-234ef422494d) | |
| 26 | +| 12 hours | [List Devices](https://api-docs.kandji.io/#78209960-31a7-4e3b-a2c0-95c7e65bb5f9) | |
| 27 | +| 12 hours | [Device Activities](https://api-docs.kandji.io/#80710108-fbdb-4dfd-af84-50adf15c5a23) | |
| 28 | +| 12 hours | [Device Details](https://api-docs.kandji.io/#efa2170d-e5f7-4b97-8f4c-da6f84ba58b5) | |
| 29 | + |
| 30 | +## Setup |
| 31 | + |
| 32 | +### Vendor configuration |
| 33 | + |
| 34 | +The Kandji source requires you to provide the Endpoint URL and Bearer Token. Follow the below steps to generate the required values: |
| 35 | + |
| 36 | +- To generate the **Endpoint URL**, follow the instructions mentioned in the [Kandji documentation](https://api-docs.kandji.io/#intro). |
| 37 | +- To generate the **Bearer Token**, follow the instructions mentioned in the [Kandji documentation](https://support.kandji.io/support/solutions/articles/72000560412-kandji-api). |
| 38 | + |
| 39 | +### Source configuration |
| 40 | + |
| 41 | +:::note |
| 42 | +Threat Details endpoint is only available for EDR customers. |
| 43 | +::: |
| 44 | + |
| 45 | +:::info |
| 46 | +While retrieving threats, the source can face data loss due to API limitations and improper pagination support. If you face any such discrepancies, contact [Sumo Logic Support](https://support.sumologic.com/support/s/). |
| 47 | +::: |
| 48 | + |
| 49 | +When you create a Kandji 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). |
| 50 | + |
| 51 | +To configure Kandji Source: |
| 52 | +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**. |
| 53 | +1. On the Collectors page, click **Add Source** next to a Hosted Collector. |
| 54 | +1. Search for and select the **Kandji** icon. |
| 55 | +1. Enter a **Name** to display for the Source in Sumo Logic. The description is optional. |
| 56 | +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`. |
| 57 | +1. (Optional) **Fields**. Click the **+Add Field** link to define the fields you want to associate. Each field needs a name (key) and value. |
| 58 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 59 | + *  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. |
| 60 | +1. In **Endpoint URL**, enter the endpoint URL collected from the Kandji platform. |
| 61 | +1. In **Bearer Token**, enter the bearer token collected from the Kandji platform. |
| 62 | +1. Select the **Collect Threat Details** checkbox to collect threat data. By default, **Collect Threat Details** checkbox will be selected. |
| 63 | +1. The **Threat Details Interval** is set for 5 minutes by default. You can adjust it based on your needs. |
| 64 | +1. In the Devices section, select the type of devices data: **Collect Devices**, **Collect Device Activities**, and/or **Collect Device Details**. |
| 65 | +1. The **Devices Interval** is set for 12 hours hours by default. You can adjust it based on your needs. |
| 66 | +1. **Processing Rules**. Configure any desired filters, such as allowlist, deny list, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). |
| 67 | +1. When you are finished configuring the Source, click **Save**. |
| 68 | + |
| 69 | +## JSON schema |
| 70 | + |
| 71 | +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. |
| 72 | + |
| 73 | +| Parameter | Type | Value | Required | Description | |
| 74 | +|:--|:--|:--|:--|:--| |
| 75 | +| schemaRef | JSON Object | `{"type":"Kandji"}` | Yes | Define the specific schema type. | |
| 76 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 77 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 78 | + |
| 79 | +### Configuration Object |
| 80 | + |
| 81 | +| Parameter | Type | Required | Default | Description | Example | |
| 82 | +|:--|:--|:--|:--|:--|:--| |
| 83 | +| 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"` | |
| 84 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` |
| 85 | +| 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"` |
| 86 | +| 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"}` | |
| 87 | +| requestEndpoint | String | Yes | `null` | The API URL to fetch the data from the Kandji EDR log source. | `https://SubDomain.api.kandji.io` | |
| 88 | +| bearerToken | String | Yes | `null` | API Token created for the user account in the Kandji portal. | | |
| 89 | +| pollingIntervalMin | Integer | Yes | 5 mins | Time interval (in minutes) after which the source will check for new data for API: Threat Details. | | |
| 90 | +| pollingIntervalHour | Integer | Yes | 12 hours | Time interval (in hours) after which the source will check for new data for API: List Devices, Collect Activities, and Collect Details. | | |
| 91 | +| collectThreatDetails | Boolean | No | `null` | Specify if we need to collect the tenant's threat details. | | |
| 92 | +| collectDevices | Boolean | No | `null` | Specify if we need to collect the tenant's devices. | | |
| 93 | +| collectDeviceActivities | Boolean | No | `null` | Specify if we need to collect the Device activity of the tenant. | | |
| 94 | +| collectDeviceDetails | Boolean | No | `null` | Specify if we need to collect the Device details of the tenant. | | |
| 95 | + |
| 96 | +### JSON example |
| 97 | + |
| 98 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 99 | + |
| 100 | +<a href="/files/c2c/kandji/example.json" target="_blank">Download example</a> |
| 101 | + |
| 102 | +### Terraform example |
| 103 | + |
| 104 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 105 | + |
| 106 | +<a href="/files/c2c/kandji/example.tf" target="_blank">Download example</a> |
| 107 | + |
| 108 | +## FAQ |
| 109 | + |
| 110 | +:::info |
| 111 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 112 | +::: |
0 commit comments