From 130f7bbdf96ac1a666f9867b70245b2397d0ab0c Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Wed, 6 Dec 2023 09:29:43 -0500 Subject: [PATCH] Document the behavior of IM rules and multi-value indicator documents (#4326) (cherry picked from commit ed4d8160ed133c768b7ac5523563cb24cbaa5f98) --- docs/detections/rules-ui-create.asciidoc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc index 79a0fa4a2c..e050f440c7 100644 --- a/docs/detections/rules-ui-create.asciidoc +++ b/docs/detections/rules-ui-create.asciidoc @@ -250,6 +250,7 @@ NOTE: For sequence events, the {security-app} generates a single alert when all NOTE: {elastic-sec} provides limited support for indicator match rules. See <> for more information. . To create a rule that searches for events whose specified field value matches the specified indicator field value in the indicator index patterns, select *Indicator Match*, then fill in the following fields: + .. *Source*: The individual index patterns or data view that specifies what data to search. .. *Custom query*: The query and filters used to retrieve the required results from the {elastic-sec} event indices. For example, if you want to match documents that only contain a `destination.ip` address field, add `destination.ip : *`. @@ -265,9 +266,13 @@ IMPORTANT: Data in indicator indices must be < "now-30d/d"` searches specified indicator indices for indicators ingested during the past 30 days and rounds the start time down to the nearest day (resolves to UTC `00:00:00`). -.. *Indicator mapping*: Compares the values of the specified event and indicator field -values. When the field values are identical, an alert is generated. To define +.. *Indicator mapping*: Compares the values of the specified event and indicator fields, and generates an alert if the values are identical. ++ +NOTE: Only single-value fields are supported. ++ +To define which field values are compared from the indices add the following: + ** *Field*: The field used for comparing values in the {elastic-sec} event indices. ** *Indicator index field*: The field used for comparing values in the indicator