Skip to content

Commit 4d48c19

Browse files
Update siemexample.md (#123)
Co-authored-by: Alan Grgic <alan.grgic@code42.com>
1 parent eedb28e commit 4d48c19

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

docs/userguides/siemexample.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
1-
# Integrating with SIEM Tools
1+
# Ingest file event data into a SIEM tool
22

3-
The Code42 command-line interface (CLI) tool offers a way to interact with your Code42 environment without using the
4-
Code42 console or making API calls directly. This article provides instructions on using the CLI to extract Code42 data
5-
for use in a security information and event management (SIEM) tool like LogRhythm, Sumo Logic, or IBM QRadar.
6-
7-
You can also use the Code42 CLI to bulk-add or remove users from the High Risk Employees list or Departing Employees
8-
list. For more information, see Manage detection list users with the Code42 command-line interface.
3+
This guide provides instructions on using the CLI to ingest Code42 file event data
4+
into a security information and event management (SIEM) tool like LogRhythm, Sumo Logic, or IBM QRadar.
95

106
## Considerations
117

12-
To integrate with a SIEM tool using the Code42 command-line interface, the Code42 user account running the integration
13-
must be assigned roles that provide the necessary permissions. We recommend you assign the roles in our use case for
14-
managing a security application integrated with Code42.
8+
To ingest file events into a SIEM tool using the Code42 command-line interface, the Code42 user account running the integration
9+
must be assigned roles that provide the necessary permissions.
1510

1611
## Before you begin
1712

18-
To integrate Code42 with a SIEM tool, you must first install and configure the Code42 CLI following the instructions in
19-
[Getting Started](gettingstarted.md) the Code42 command-line interface.
13+
First install and configure the Code42 CLI following the instructions in
14+
[Getting Started](gettingstarted.md).
2015

21-
## Commands and query parameters
16+
## Run file event queries
2217
You can get security events in either a JSON or CEF format for use by your SIEM tool. You can query the data as a
2318
scheduled job or run ad-hoc queries. Learn more about [searching](../commands/securitydata.md) using the CLI.
2419

@@ -31,8 +26,7 @@ the profile to use by including `--profile`. An example using `netcat` to forwar
3126
code42 security-data search --profile profile1 -c syslog_sender | nc syslog.example.com 514
3227
```
3328

34-
Note that it is best practice to use a separate profile when executing a scheduled task. This way, it is harder to
35-
accidentally mess up your stored checkpoints by running `--use-checkpoint` in adhoc queries.
29+
As a best practice, use a separate profile when executing a scheduled task. Using separate profiles can help prevent accidental updates to your stored checkpoints, for example, by adding `--use-checkpoint` to adhoc queries.
3630

3731
This query will send to the syslog server only the new security event data since the previous request.
3832

@@ -101,7 +95,7 @@ The following tables map the data from the Code42 CLI to common event format (CE
10195

10296
### Attribute mapping
10397

104-
The table below maps JSON fields, CEF fields, and [Forensic Search fields](https://support.code42.com/Administrator/Cloud/Administration_console_reference/Forensic_Search_reference_guide)
98+
The table below maps JSON fields, CEF fields, and [Forensic Search fields](https://code42.com/r/support/forensic-search-fields)
10599
to one another.
106100

107101
```eval_rst

0 commit comments

Comments
 (0)