...
To retrieve the EPM policy alerts and events, CyberArk provides new API commands.
Devo collector features
Feature | Details |
---|
Allow parallel downloading (multipod ) | allowed
|
Running environments | collector server
on-premise
|
Populated Devo events | table
|
Flattening preprocessing | no
|
Allowed source events obfuscation | yes
|
Data sources
Data source | Description | API endpoint | Collector service name | Devo table | Available from release |
Admin audit data | Admin audit indicates the full list of actions carried out by admin in your environment | Sets/{set_id}/AdminAudit
| admin_audit
| epm.cyberark.epm.admin_audit
| v1.0.0
|
Raw events | This enables to retrieve the events in the system, such as user login failure events, etc. | Sets/{set_id}/Events/search
| event
| epm.cyberark.epm.event
| v1.0.0
|
Policy audit events | Retrieves policy audit events in the system, such as admin privileges. | Sets/{set_id}/policyaudits/search
| policy_event
| epm.cyberark.epm.policy_event
| v1.0.0
|
Aggregated events | Retrieves aggregated events in the system, such as number of attack attempts, etc. | Sets/{set_id}/aggregations/search
| event_aggregated
| epm.cyberark.epm.event_aggregated
| v1.0.0
|
Aggregated policy audit events | This enables to retrieve of the aggregated policy events in the system, such as the number of times the application is launched, the number of times blocked | Sets/{set_id}/policyaudits/aggregations/search
| policy_audit_aggregated
| epm.cyberark.epm.policy_audit_aggregated
| v1.0.0
|
For more information on how the events are parsed, visit our page.
Vendor setup
We need email, password, and app ID to start.
...
Info |
---|
This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details. |
Setting | Details |
email
| The email your CyberArk account is associated with. |
password
| Password for the said account. |
app id
| Source application ID that distinguishes between REST API calls from EPM and REST API calls from another application. We recommend that you specify the customer's name. |
login url
| Based on your region you will be receiving that from CyberArk in your email box. For instance, for United States is http://login.epm.cyberark.com For UK http://uk.epm.cyberark.com For Canada http://ca.epm.cyberark.com |
Accepted authentication methods
Authentication method | Token |
Token | Required |
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Rw ui tabs macro |
---|
We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration. Rw tab |
---|
title | On-premise collector |
---|
|
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running. StructureThe following directory structure should be created for being used when running the collector: Code Block |
---|
<any_directory>
└── devo-collectors/
└── <product_name>/
├── certs/
│ ├── chain.crt
│ ├── <your_domain>.key
│ └── <your_domain>.crt
├── state/
└── config/
└── config.yaml |
Note |
---|
Replace <product_name> with the proper value. |
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/ . Learn more about security credentials in Devo here. Image RemovedImage Added Note |
---|
Replace <product_name> with the proper value. |
Editing the config.yaml file Code Block |
---|
globals:
debug: false
id: not_used
name: cyberark_epm
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_1:
type: devo_platform
config:
address: <some_url>.<some_region>.devo.io
port: <PORT>
type: SSL
chain: <some_chain.crt>
cert: <some_certificate.crt>
key: <some_key.key>
console_1:
type: console
inputs:
cyberark:
id: "<short_unique_id>"
enabled: true
credentials:
auth_url: <auth_url>
username: <username>
password: <password>
application_id: <app_id>
services:
admin_audit:
date_from: <date_from>
tag: <tag>
raw_events:
date_from: <date_from>
tag: <tag>
policy_event:
date_from: <date_from>
tag: <tag>
aggregate_events:
date_from: <date_from>
tag: <tag>
aggregated_policy_audit:
date_from: <date_from>
tag: <tag> |
Info |
---|
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object. |
Replace the placeholders with your required values following the description table below: Parameter | Data type | Type | Value Range / Format | Details |
---|
debug_status
| bool
| Mandatory
| false / true | If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning and error logging levels will be printed. | address
| str
| Mandatory
| | The address associated with your Devo account where your data will be received. | auth_url
| str
| Mandatory
| | The auth url associated with your CyberArk account. | username
| str
| Mandatory
| | The username associated with your CyberArk account. | password
| str
| Mandatory
| | The password associated with your CyberArk account | application_id
| str
| Mandatory
| | The application id associated with your CyberArk account. | from_date
| str
| Optional
| | The date from which you want to fetch data for each service. If not provides, ‘current_time - 1 hr’ will be taken. | tag
| str
| Optional
| | Tag where you want to send data. If not provided, default values will be taken. Refer to Data source description section. |
Download the Docker imageThe collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table: Use the following command to add the Docker image to the system: Code Block |
---|
gunzip -c <image_file>-<version>.tgz | docker load |
Note |
---|
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <image_file> and <version> with a proper value. |
The Docker image can be deployed on the following services: DockerExecute the following command on the root directory <any_directory>/devo-collectors/<product_name>/ Code Block |
---|
docker run
--name collector-<product_name>
--volume $PWD/certs:/devo-collector/certs
--volume $PWD/config:/devo-collector/config
--volume $PWD/state:/devo-collector/state
--env CONFIG_FILE=config.yaml
--rm
--interactive
--tty
<image_name>:<version> |
Note |
---|
Replace <product_name> , <image_name> and <version> with the proper values. |
Docker ComposeThe following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory. Code Block |
---|
version: '3'
services:
collector-<product_name>:
image: <image_name>:${IMAGE_VERSION:-latest}
container_name: collector-<product_name>
volumes:
- ./certs:/devo-collector/certs
- ./config:/devo-collector/config
- ./credentials:/devo-collector/credentials
- ./state:/devo-collector/state
environment:
- CONFIG_FILE=${CONFIG_FILE:-config.yaml} |
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory: Code Block |
---|
IMAGE_VERSION=<version> docker-compose up -d |
Note |
---|
Replace <product_name> , <image_name> and <version> with the proper values. | We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration |
Collector services detail
...