# Collect CyberArk logs

**Parser Version:** 8.0
Supported in:

This document explains how to ingest CyberArk logs into Google Security Operations using the Bindplane agent.

CyberArk Privileged Access Manager (PAM) is an enterprise-grade privileged access security solution that secures, manages, and monitors privileged accounts and credentials across on-premises and cloud environments. It provides credential vaulting, session isolation and monitoring, threat detection through Privileged Threat Analytics (PTA), and comprehensive audit logging of all privileged activities.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance
- Windows Server 2016 or later, or Linux host with `systemd`
- Network connectivity between the Bindplane agent and the CyberArk Vault Server
- If running behind a proxy, ensure firewall ports are open as per the Bindplane agent requirements
- Administrative access to the CyberArk Vault Server (access to the `Server\Conf` installation folder)
- CyberArk Vault version 10.0 or later

## Get Google SecOps credentials for the Bindplane agent

To authenticate the Bindplane agent to Google SecOps, choose one of the following methods:

- **New deployments**: Use the Chronicle API (Option 1).
- **Legacy deployments**: Continue using the ingestion authentication file (Option 2) until the Ingestion API is discontinued on July 20, 2027.

### Option 1: Create a service account for the Chronicle API (recommended)

1. Sign in to the [Google Cloud console](https://console.cloud.google.com/) and select the Google Cloud project that is linked to your Google SecOps instance.
2. Go to **IAM \& Admin \> Service Accounts**.
3. Click **Create service account**.
4. Provide the following configuration details:
   - **Service account name** : Enter a name for the account (for example, `bindplane-ingest`).
   - **Service account description** : Enter a description (for example, `Bindplane agent log ingestion`).
5. Click **Create and continue**.
6. In the **Grant this service account access to project** section, click **Select a role** and select **Chronicle Editor**.
7. Click **Continue** , and then click **Done**.
8. Click the service account you created, and then go to the **Keys** tab.
9. Click **Add key \> Create new key**.
10. Select **JSON** and click **Create**. The key file is downloaded to your computer.
11. Save the key file as `ingestion-auth.json` in the Bindplane collector directory (`/opt/observiq-otel-collector/ingestion-auth.json` on Linux or `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json` on Windows), or update `creds_file_path` in `config.yaml` to match the path where you save it.
12. Go to **IAM \& Admin \> Settings** and copy the **Project number**. You'll need it for the exporter configuration.

> [!NOTE]
> **Note:** The JSON key is a credential. Restrict access to the file on the Bindplane host and rotate the key according to your organization's policy.

### Option 2: Download the ingestion authentication file (legacy)

1. Sign in to the Google SecOps console.
2. Go to **Settings \> Data Management \> Collection Agents** . If you are on a SIEM-only platform, go to **Settings \> Collection Agents**.
3. Download the **ingestion authentication file**.
4. Save the file securely on the system where the Bindplane agent will be installed.

> [!NOTE]
> **Note:** This file authenticates the agent to the legacy Ingestion API (`malachiteingestion-pa.googleapis.com`), which Google has scheduled for end of life on July 20, 2027. Plan to move to Option 1 before that date.

## Get Google SecOps customer ID

1. Sign in to the Google SecOps console.
2. Go to **Settings \> Administration \> Profile** . If you are on a SIEM-only platform, go to **Settings \> Profile**.
3. Copy and save the **Customer ID** from the **Organization Details** section.

   > [!NOTE]
   > **Note:** The customer ID is required for configuring the Bindplane agent exporter.

## Install the Bindplane agent

Install the Bindplane agent on your Windows or Linux operating system according to the following instructions.

### Windows installation

1. Open **Command Prompt** or **PowerShell** as an administrator.
2. Run the following command:

       msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

3. Wait for the installation to complete.

4. Verify the installation by running:

       sc query observiq-otel-collector

   The service status should be **RUNNING**.

### Linux installation

1. Open a terminal with root or sudo privileges.
2. Run the following command:

       sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

3. Wait for the installation to complete.

4. Verify the installation by running:

       sudo systemctl status observiq-otel-collector

   The service status should be **active (running)**.

### Additional installation resources

For additional installation options and troubleshooting, see [Bindplane agent installation guide](https://docs.cloud.google.com/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).

> [!NOTE]
> **Note:** The Chronicle API exporter configuration requires Bindplane collector v1.106.0 or later. The previous commands install the latest release. If you're updating an existing installation, upgrade the collector before changing the configuration.

## Configure the Bindplane agent to ingest syslog and send it to Google SecOps

### Locate the configuration file

- Linux:

      sudo nano /opt/observiq-otel-collector/config.yaml

- Windows:

      notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"

### Edit the configuration file

1. Replace the entire contents of `config.yaml` with the following configuration:

       receivers:
         udplog:
           listen_address: "0.0.0.0:514"

       exporters:
         chronicle/cyberark:
           protocol: https
           # Region of your instance, for example us, europe, asia-southeast1
           location: <LOCATION>
           # Project number of the Google Cloud project linked to the instance
           project: '<PROJECT_NUMBER>'
           compression: gzip
           creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
           customer_id: 'your-customer-id'
           endpoint: chronicle.googleapis.com
           log_type: CYBERARK
           raw_log_field: body

       service:
         pipelines:
           logs/cyberark_to_chronicle:
             receivers:
               - udplog
             exporters:
               - chronicle/cyberark

2. Replace the following placeholders:

   - Receiver configuration:

     - `listen_address`: IP address and port to listen on:

       - `0.0.0.0:514` to listen on all interfaces on port 514 (requires root on Linux)
       - `0.0.0.0:1514` to listen on an unprivileged port (recommended for Linux non-root)
     - Receiver type options:

       - `udplog` for UDP syslog (default for CyberArk Vault)
       - `tcplog` for TCP syslog
       - Use `tcplog` if CyberArk Vault is configured with `SyslogServerProtocol=TCP`
   - Exporter configuration:

     - `creds_file_path`: Full path to the service account JSON key file (Option 1):

       - **Linux** : `/opt/observiq-otel-collector/ingestion-auth.json`
       - **Windows** : `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json`
     - `customer_id`: Google SecOps customer ID

     - `location`: Replace `<LOCATION>` with the region of your Google SecOps instance (for example, `us`, `europe`, or `asia-southeast1`). The exporter prefixes `chronicle.googleapis.com` with this value. See [Regional Endpoints](https://docs.cloud.google.com/chronicle/docs/reference/rest?rep_location=us#regional-service-endpoint) for the complete list.

     - `project`: Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.

     - `endpoint`: Keep set to `chronicle.googleapis.com`.

### Legacy ingestion API exporter

- If you use the ingestion authentication file from Option 2, replace the `exporters` block with the following. Set `creds_file_path` to the path to the ingestion authentication file, and if your instance is outside the US, replace `malachiteingestion-pa.googleapis.com` with your [regional endpoint](https://docs.cloud.google.com/chronicle/docs/reference/ingestion-api#regional-endpoints) (for example, `europe-malachiteingestion-pa.googleapis.com`).

      exporters:
        chronicle/cyberark:
          compression: gzip
          creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: 'your-customer-id'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: CYBERARK
          raw_log_field: body

> [!NOTE]
> **Note:** This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

### Save the configuration file

After editing, save the file:

- **Linux** : Press `Ctrl+O`, then `Enter`, then `Ctrl+X`
- **Windows** : Click **File \> Save**

## Restart the Bindplane agent to apply the changes

- To restart the Bindplane agent in Linux:

  1. Run the following command:

         sudo systemctl restart observiq-otel-collector

  2. Verify that the service is running:

         sudo systemctl status observiq-otel-collector

  3. Check the logs for errors:

         sudo journalctl -u observiq-otel-collector -f

- To restart the Bindplane agent in Windows:

  1. Choose one of the following options:

     - Command Prompt or PowerShell as administrator:

           net stop observiq-otel-collector && net start observiq-otel-collector

     - Services console:

       1. Press `Win+R`, type `services.msc`, and press Enter.
       2. Locate **observIQ OpenTelemetry Collector**.
       3. Right-click and select **Restart**.
  2. Verify that the service is running:

         sc query observiq-otel-collector

  3. Check the logs for errors:

         type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"

## Configure CyberArk syslog forwarding

CyberArk Vault sends audit events in CEF (Common Event Format) via syslog. The Vault Server converts XML audit records to CEF messages using an XSL translator file, then forwards them to the Bindplane agent.

### Configure the Vault Server to send syslog

1. Sign in to the CyberArk Vault Server host machine with administrator privileges.
2. Navigate to the CyberArk Vault Server installation folder (for example, \`C:\\Program Files (x86)\\PrivateArk\\Server\\Conf\`).
3. Open the `DBParm.ini` file in a text editor.
4. Copy the `[SYSLOG]` section from the `DBParm.sample.ini` file (located in the same folder) and paste it at the bottom of `DBParm.ini`.
5. Configure the following syslog parameters in the `[SYSLOG]` section:

       [SYSLOG]
       SyslogServerIP=<BINDPLANE_AGENT_IP>
       SyslogServerPort=514
       SyslogServerProtocol=UDP
       UseLegacySyslogFormat=No
       SyslogTranslatorFile=Syslog\Arcsight.sample.xsl
       SyslogMessageCodeFilter=0-999

6. Replace the following values:

   - **SyslogServerIP** : Enter the IP address of the Bindplane agent host (for example, `192.168.1.100`).
   - **SyslogServerPort** : Enter the port matching the Bindplane agent `listen_address` (for example, `514`).
   - **SyslogServerProtocol**: Select the protocol:

     - `UDP` for UDP syslog (default)
     - `TCP` for TCP syslog
   - **SyslogTranslatorFile**: Enter the XSL translator file for CEF format:

     - `Syslog\Arcsight.sample.xsl` for standard CEF output (recommended)
   - **SyslogMessageCodeFilter**: Enter the message codes to forward:

     - `0-999` to forward all events
     - Specify individual codes or ranges (for example, `1,2,3,5-10,30`) to filter specific events
   - **UseLegacySyslogFormat** : Set to `No` for RFC 5424 format.

7. Save the `DBParm.ini` file.

8. Restart the **PrivateArk Server** service:

   1. Open **Windows Services** (`services.msc`).
   2. Locate the **CyberArk Vault Disaster Recovery** service and stop it (if running).
   3. Locate the **PrivateArk Server** service.
   4. Right-click and select **Restart**.
   5. Start the **CyberArk Vault Disaster Recovery** service again (if applicable).

   > [!NOTE]
   > **Note:** Restarting the PrivateArk Server service temporarily interrupts Vault connectivity. Schedule this during a maintenance window.

### Forward syslog to multiple destinations

- To forward Vault syslog events to both the Bindplane agent and other destinations (for example, PTA), specify multiple IP addresses and translator files separated by commas:

      SyslogServerIP=<BINDPLANE_AGENT_IP>,<PTA_SERVER_IP>
      SyslogTranslatorFile=Syslog\Arcsight.sample.xsl,Syslog\PTA.xsl

  > [!NOTE]
  > **Note:** All destinations share the same port and protocol configured in `SyslogServerPort` and `SyslogServerProtocol`.

### Configure Privileged Threat Analytics (PTA) syslog forwarding (optional)

If you also want to forward PTA security alerts to Google SecOps, configure PTA SIEM integration:

1. Sign in to the **PVWA** (Password Vault Web Access) console.
2. Go to **Administration \> Configuration Options \> Privileged Threat Analytics**.
3. In the **SIEM** section, configure the following:
   - **Syslog Server IP**: Enter the IP address of the Bindplane agent host.
   - **Syslog Server Port** : Enter the port matching the Bindplane agent configuration (for example, `514`).
   - **Protocol** : Select **UDP** or **TCP** to match the Bindplane agent receiver.
   - **Format** : Select **CEF**.
4. Click **Save**.

### Available XSL translator files

- The `Syslog` subfolder in the CyberArk Server installation folder contains sample XSL translator files:

  | Translator File | Format | Description |
  |---|---|---|
  | `Arcsight.sample.xsl` | CEF | Standard CEF format (recommended for Google SecOps) |
  | `SplunkCIM.xsl` | CIM | Splunk Common Information Model format |
  | `PTA.xsl` | Custom | Format for forwarding to CyberArk PTA |
  | `XSIAM.xsl` | CEF | Palo Alto Cortex XSIAM format |

  > [!NOTE]
  > **Note:** Use `Arcsight.sample.xsl` for Google SecOps ingestion. This translator outputs standard CEF messages that the CyberArk parser can process.

### Verify syslog forwarding

1. After restarting the PrivateArk Server service, perform a test action in the Vault (for example, retrieve a password or sign in to PVWA).
2. Check the Bindplane agent logs for incoming syslog messages:
   - **Linux** : `sudo journalctl -u observiq-otel-collector -f`
   - **Windows** : `type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"`
3. Verify that CEF-formatted messages appear in the logs, for example:

       CEF:0|Cyber-Ark|Vault|10.0|22|CPM password retrieved|5|suser=Administrator src=10.0.0.1 fname=Root\operating system-server1-admin

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| RequestId_label | additional.fields | Mapped as key-value pair |
| Category_label | additional.fields | Mapped as key-value pair |
| ExtraDetails_label | additional.fields | Mapped as key-value pair |
| CAPolicy_label | additional.fields | Mapped as key-value pair |
| line_number_label | additional.fields | Mapped as key-value pair |
| pasvc_action_label | additional.fields | Mapped as key-value pair |
| control_socket_label | additional.fields | Mapped as key-value pair |
| data_socket_label | additional.fields | Mapped as key-value pair |
| timeout_label | additional.fields | Mapped as key-value pair |
| vault_name_label | additional.fields | Mapped as key-value pair |
| class_name_label | additional.fields | Mapped as key-value pair |
| status_label | additional.fields | Mapped as key-value pair |
| Publisher_Event | additional.fields | Mapped as key-value pair |
| Last_Event | additional.fields | Mapped as key-value pair |
| Total_Events | additional.fields | Mapped as key-value pair |
| cs1_var | additional.fields | Mapped as key-value pair |
| cs3_var | additional.fields | Mapped as key-value pair |
| app_var | additional.fields | Mapped as key-value pair |
| reason_var | additional.fields | Mapped as key-value pair |
| cs5_var | additional.fields | Mapped as key-value pair |
| cs4_var | additional.fields | Mapped as key-value pair |
| _auth_mechanism | extensions.auth.mechanism | Directly merged |
| dvc | intermediary.ip | If value matches IP address pattern |
| EventName | metadata.description | If process does not match exe pattern |
| act | metadata.description | If fname is empty |
| EventMessage | metadata.description | If act is empty |
| LastEventDate | metadata.event_timestamp | Converted using ISO8601 or yyyy-MM-ddTHH:mm:ss format |
| _temp_datetime | metadata.event_timestamp | Converted using dd/MM/yyyy HH:mm:ss format |
| datetime | metadata.event_timestamp | Converted using ISO8601 or MMM d HH:mm:ss format |
| _event_type | metadata.event_type | Directly renamed |
| name | metadata.event_type | Set based on conditions: FILE_CREATION for "Store File", USER_LOGIN for "Logon", NETWORK_CONNECTION if has_principal and has_target, FILE_UNCATEGORIZED if has_target_file_details, PROCESS_UNCATEGORIZED if has_target_process_details, STATUS_UPDATE if has_principal only, NETWORK_UNCATEGORIZED if app_error and has_principal and has_target, otherwise GENERIC_EVENT |
| EventType | metadata.product_event_type | Directly mapped |
| signature_id, name | metadata.product_event_type | Concatenated from signature_id and name |
| LastEventID | metadata.product_log_id | Converted to string |
| tid | metadata.product_log_id | Directly mapped |
| product | metadata.product_name | Directly renamed |
| version | metadata.product_version | Directly renamed |
| vendor | metadata.vendor_name | Directly renamed |
| host | observer.hostname | Directly mapped |
| LastEventUserName | principal.administrative_domain | Extracted using grok pattern domain\\user |
| ApplicationType | principal.application | Directly mapped |
| shost | principal.asset.hostname | If value does not match IP address pattern |
| shost | principal.asset.hostname | Fallback if dhost is empty |
| shost | principal.asset.ip | If value matches IP address pattern |
| src | principal.asset.ip | Directly mapped |
| ip_address | principal.asset.ip | Directly mapped |
| shost | principal.asset.ip | Fallback if dhost is empty |
| shost | principal.ip | If value matches IP address pattern, merged |
| src | principal.ip | Directly merged |
| ip_address | principal.ip | Directly merged |
| Location | principal.location.name | Directly mapped |
| LastEventSourceName | principal.platform | Set to WINDOWS if value matches Windows pattern |
| EventName | principal.process.command_line | If process matches exe pattern |
| LastEventPackageName | principal.resource.name | If value is not EventName |
| ApplicationType | principal.user.attribute.roles | Set to ADMINISTRATOR if value equals AdminTask |
| LastEventUserName | principal.user.user_display_name | User portion extracted using grok pattern domain\\user |
| user_name | principal.user.user_display_name | Directly mapped |
| SourceUser | principal.user.userid | Directly mapped |
| suser | principal.user.userid | If event is not USER_ type |
| usrName | principal.user.userid | Directly mapped |
| _action | security_result.action | Directly merged |
| name | security_result.action | Set to BLOCK if value starts with "Failure" or "Failed", otherwise ALLOW |
| msg | security_result.description | Directly mapped |
| msg, reason | security_result.description | Concatenated from msg and reason if failure condition |
| _sec_result_description | security_result.description | Directly mapped |
| PolicyName | security_result.rule_name | Directly mapped |
| cs2 | security_result.rule_name | Directly mapped |
| severity | security_result.severity | Set to LOW if value \<= 5, MEDIUM if value \<= 8, HIGH otherwise |
| sev | security_result.severity | Directly mapped |
| sev | security_result.severity_details | Directly mapped |
| Reason | security_result.summary | Directly mapped |
| name | security_result.summary | Directly mapped |
| dhost | target.asset.hostname | If value does not match IP address pattern |
| shost | target.asset.hostname | Fallback if dhost is empty |
| dhost | target.asset.ip | If value matches IP address pattern |
| GatewayStation | target.asset.ip | Directly mapped |
| shost | target.asset.ip | Fallback if dhost is empty |
| FileQualifier | target.asset_id | Prefixed with "ASSET ID:" and converted to string |
| File | target.file.full_path | Directly mapped |
| file_path | target.file.full_path | Directly mapped |
| LastEventSourceName | target.file.full_path | If value starts with "C:" |
| fname | target.file.full_path | Directly mapped |
| Hash | target.file.sha1 | "SHA1##" prefix removed and value lowercased, if SHA1 type |
| GatewayStation | target.ip | Directly merged |
| pid | target.process.pid | Converted to string |
| Safe | target.resource.name | Directly mapped |
| user_name | target.user.user_display_name | Directly mapped |
| TargetUser | target.user.userid | Directly mapped |
| duser | target.user.userid | Directly mapped |
| suser | target.user.userid | If event is USER_ type |
| `event_msg.created` | `event.idm.read_only_udm.metadata.collected_timestamp` | Mapped from changelog |
| `datetime` | `event.idm.read_only_udm.metadata.event_timestamp` | Mapped from changelog |
| `Issuer` | `event.idm.read_only_udm.principal.application` | Mapped from changelog |
| `Message` | `event.idm.read_only_udm.security_result.description` | Mapped from changelog |
| `Station` | `event.idm.read_only_udm.principal.ip`, `event.idm.read_only_udm.principal.asset.ip` | Mapped from changelog |
| `MessageID` | `event.idm.read_only_udm.metadata.product_log_id` | Mapped from changelog |
| `Safe` | `event.idm.read_only_udm.target.resource.name` | Mapped from changelog |
| `Version` | `event.idm.read_only_udm.metadata.product_version` | Mapped from changelog |
| `usrName` | `event.idm.read_only_udm.principal.user.userid` | Mapped from changelog |
| `src` | `event.idm.read_only_udm.principal.ip` and `event.idm.read_only_udm.principal.asset.ip` | Mapped from changelog |
| `GatewayStation` | `event.idm.read_only_udm.target.ip` and `event.idm.read_only_udm.target.asset.ip` | Mapped from changelog |
| `Reason` | `event.idm.read_only_udm.security_result.summary` | Mapped from changelog |
| `Location` | `event.idm.read_only_udm.principal.location.name` | Mapped from changelog |
| `File` | `event.idm.read_only_udm.target.file.full_path` | Mapped from changelog |
| `RequestId` | `security_result.detection_fields` | Mapped from changelog |
| `sev` | `event.idm.read_only_udm.security_result` | Mapped from changelog |
| `Category` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `ExtraDetails` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `CAPolicy` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `status` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `class_name` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `vault_name` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `timeout` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `data_socket` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `control_socket` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `pasvc_action` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `line_number` | `event.idm.read_only_udm.additional.fields` | Mapped from changelog |
| `ip_address` | `event.idm.read_only_udm.principal.ip` and `event.idm.read_only_udm.principal.asset.ip` | Mapped from changelog |
| `file_path` | `event.idm.read_only_udm.target.file.full_path` | Mapped from changelog |
| `tid` | `event.idm.read_only_udm.metadata.product_log_id` | Mapped from changelog |
| `pid` | `event.idm.read_only_udm.target.process.pid` | Mapped from changelog |
| `EventMessage` | `event.idm.read_only_udm.metadata.description` | Mapped from changelog |
| `SourceUser` | `event.idm.read_only_udm.principal.user.userid` | Mapped from changelog |
| `TargetUser` | `event.idm.read_only_udm.target.user.userid` | Mapped from changelog |
| `user_name` | `event.idm.read_only_udm.target.user.user_display_name` | Mapped from changelog |
| `host` | `event.idm.read_only_udm.observer.hostname` | Mapped from changelog |

## Change Log

[View the Change Log for this parser](https://docs.cloud.google.com/chronicle/docs/ingestion/parser-list/cyberark-changelog)

**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/)