|
| 1 | +--- |
| 2 | +id: cyberark-audit-source |
| 3 | +title: CyberArk Audit Source |
| 4 | +sidebar_label: CyberArk Audit |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - cyberark-audit |
| 8 | +description: This integration accesses CyberArk SIEM integration API to retrieve audit events. |
| 9 | +--- |
| 10 | +import CodeBlock from '@theme/CodeBlock'; |
| 11 | +import ExampleJSON from '/files/c2c/cyberark-audit/example.json'; |
| 12 | +import MyComponentSource from '!!raw-loader!/files/c2c/cyberark-audit/example.json'; |
| 13 | +import TerraformExample from '!!raw-loader!/files/c2c/cyberark-audit/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/cyberark.png')} alt="icon" width="50"/> |
| 18 | + |
| 19 | +The CyberArk Identity Security platform is a comprehensive identity management solution that enhances enterprise security through features such as single sign-on, multi-factor authentication, and privileged access control. It streamlines identity operations while providing extensive protection against both external and internal cyber threats. |
| 20 | + |
| 21 | +The Audit service offers detailed audit trails for activities, events, and sessions conducted by any integrated service on the Shared Services platform. An audit trail is a recorded history of activities that have taken place within the system. This information can be utilized for various purposes, including security, regulatory compliance, incident response investigations, and troubleshooting. |
| 22 | + |
| 23 | +## Data collected |
| 24 | + |
| 25 | +| Polling Interval | Data | |
| 26 | +| :--- | :--- | |
| 27 | +| 5 minutes | [Audits](https://docs.cyberark.com/audit/latest/en/content/audit/isp_siem-integration-api.htm?tocpath=Developer%7C_____1) | |
| 28 | + |
| 29 | +## Setup |
| 30 | + |
| 31 | +### Vendor configuration |
| 32 | + |
| 33 | +In this configuration, you will set up a CyberArk audit source and configure it to be authorized and authenticated to use CyberArk Audit SIEM API. CyberArk audit supports OAuth authentication. |
| 34 | + |
| 35 | +Follow the instructions mentioned in the [CyberArk Documentation](https://docs.cyberark.com/audit/latest/en/content/audit/isp_siem-integration.htm?tocpath=SIEM%20integrations%7C_____1) to retrieve the following parameters to configure the CyberArk audit source. |
| 36 | + |
| 37 | +1. Identity Id |
| 38 | +1. App Id |
| 39 | +1. Username(Client ID) |
| 40 | +1. Password(Client Secret) |
| 41 | +1. Tenant URL |
| 42 | +1. API Key |
| 43 | + |
| 44 | +### Source configuration |
| 45 | + |
| 46 | +When you create a CyberArk Audit 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](/docs/send-data/hosted-collectors/configure-hosted-collector.md). |
| 47 | + |
| 48 | +To configure a CyberArk Audit source, follow the steps below: |
| 49 | +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**. |
| 50 | +1. On the Collection page, click **Add Source** next to a Hosted Collector. |
| 51 | +1. Search for and select **CyberArk Audit**. |
| 52 | +1. **Name**. Enter a name to display for the source. The description is optional. |
| 53 | +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`. |
| 54 | +1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value. |
| 55 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 56 | + *  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. |
| 57 | +1. **Identity ID**. Enter your identity ID collected from the [Vendor configuration](#vendor-configuration) section. For example, `abr4338`. |
| 58 | +1. **Web Application ID**. Enter your application ID collected from the [Vendor configuration](#vendor-configuration) section. For example, `sumologic`. |
| 59 | +1. **Username **. Enter your username(client-id) collected from the [Vendor configuration ](#vendor-configuration) section. For example, `[email protected]`. |
| 60 | +1. **Password**. Enter your password(client-secret) collected from the [Vendor configuration](#vendor-configuration) section. |
| 61 | +1. **Tenant URL**. Enter your tenant URL collected from the [Vendor configuration](#vendor-configuration) section. For example, `https://sumologic.audit.cyberark.cloud`. |
| 62 | +1. **API Key**. Enter your API key collected from the [Vendor configuration](#vendor-configuration) section. |
| 63 | +1. (Optional) **Service Type**. Enter the service types to filter the audits. |
| 64 | +1. (Optional) **Status Type**. Enter the status types to filter the audits. |
| 65 | +1. (Optional) **Action Type**. Enter the action types to filter the audits. |
| 66 | +1. **Polling Interval**. The polling interval is the frequency at which the CyberArk Audit C2C source will check for updates from the CyberArk Audit API. By default, the polling interval is set to 5 minutes. |
| 67 | +1. (Optional) **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). |
| 68 | +1. When you are finished configuring the Source, click **Save**. |
| 69 | + |
| 70 | +## JSON schema |
| 71 | + |
| 72 | +Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [how to use JSON to configure Sources](/docs/send-data/use-json-configure-sources) for details. |
| 73 | + |
| 74 | +| Parameter | Type | Value | Required | Description | |
| 75 | +|:--|:--|:--|:--|:--| |
| 76 | +| schemaRef | JSON Object | `{“type”: “CyberArk Audit”}` | Yes | Define the specific schema type. | |
| 77 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 78 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 79 | + |
| 80 | +### Configuration Object |
| 81 | + |
| 82 | +| Parameter | Type | Required | Default | Description | Example | |
| 83 | +|:--|:--|:--|:--|:--|:--| |
| 84 | +| 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"` | |
| 85 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` | |
| 86 | +| 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"` | |
| 87 | +| 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"}` | |
| 88 | +| identityId | String | Yes | `null` | Identity ID for your CyberArk account. | `abr4338` | |
| 89 | +| appId | String | Yes | `null` | App ID for your CyberArk account. | `sumologic` | |
| 90 | +| username | String | Yes | `null` | Username(Client ID) for your configured server. | `[email protected]` | |
| 91 | +| password | String | Yes | `null` | Password for your configured server. | | |
| 92 | +| tenantURL | String | Yes | `null` | Tenant URL for your configured server. | `https://sumologic.audit.cyberark.cloud` | |
| 93 | +| apiKey | String | Yes | `null` | API key for your configured server. | | |
| 94 | +| serviceType | Array | No | `null` | Type of audit services to filter data from. | | |
| 95 | +| statusType | Array | No | `null` | Type of audit statuses to filter data from. | | |
| 96 | +| actionType | Array | No | `null` | Type of audit actions to filter data from. | | |
| 97 | +| pollingIntervalMin | integer | Yes | 5 minutes | Frequency of C2C updates from CyberArk Audit. | | |
| 98 | + |
| 99 | +### JSON example |
| 100 | + |
| 101 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 102 | + |
| 103 | +<a href="/files/c2c/cyberark-audit/example.json" target="_blank">Download example</a> |
| 104 | + |
| 105 | +### Terraform example |
| 106 | + |
| 107 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 108 | + |
| 109 | +<a href="/files/c2c/cyberark-audit/example.tf" target="_blank">Download example</a> |
| 110 | + |
| 111 | +## FAQ |
| 112 | + |
| 113 | +:::info |
| 114 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 115 | +::: |
0 commit comments