Skip to main content

Behavior Rules

The Behavior Rules page lists the behavior detection rules in the account: the rules that score entity behavior and raise behaviors from matching events. From here you can search, filter, and sort the rule list, choose which columns it shows, open any rule in a detail panel, create a rule, edit or delete the rules of your own, and open the Behavior Filters page that holds the rules' exceptions.

Menu path: Configuration → Behavior Rules · URL path: /v2/configuration/behavior-rules

Task guide: Creating a Behavior Rule: building a rule step by step; Managing Rules: cloning, deactivating, and tuning rules.

Behavior Rules page showing the search bar with the sort drop-down and the Search, Behavior Filters, and Create Rule buttons, the facet panel on the left, and the rule table with name, category, tags, active switch, and last-updated columns

Page Layout​

  • Header: a Back to Configuration link above the title Behavior Rules and the subtitle Listing of Behavior Rules.
  • Search bar: a full-width search field (placeholder Search rules by name, description, field…), the sort drop-down, and the Search, Behavior Filters, and + Create Rule buttons.
  • List toolbar: the rule count on the left (for example 395 of 395 rules), and the JSON line and ⚙ Columns buttons on the right.
  • Filters panel (left): groups of checkbox facets for narrowing the rule list.
  • Rule table (right): one row per rule, with pagination underneath.

Search and Sort​

Type in the search field and press Enter or click Search to filter the rule list to the rules whose name, description, or fields match. When no rule matches, the table reads No behavior rules match this search. and each filter group No values in this window. The drop-down beside the field orders the list:

  • Rule Name: A-Z: alphabetical by rule name; the order the page opens with.
  • Rule Name: Z-A: reverse alphabetical.
  • Last Updated: the most recently updated rules first.

Filters Panel​

The FILTERS panel groups the rules by attribute. Each group heading shows how many distinct values it has, and each value is a checkbox with the number of rules that carry it:

GroupExample values
CategoryOffice365, AWS, AD, GoogleWorkspace-Behaviors, AzureAD, Network
Behaviorsapplication activity, security alert, account login, network access, privilege change, account change
Filterfield, exists, entityinfo, contains
Event Typeevent, metaflow
Aggregation Typefirst, aggregation
TagsO365, AD, GoogleWorkspace, GSuite, sigma, AWS
RepositoryFluency
Disabledfalse, true

A group shows its most common values first; a + N more link under the list reveals the rest, and Show less hides them again. The « button in the panel's header collapses the panel to give the table the full width; » FILTERS opens it again.

Ticking a value narrows the table to the rules that carry it and adds a chip for it above the table, such as Category: AWS ×, with a Clear all button. A chip's × removes that filter; Clear all removes them all.

List Toolbar​

JSON Line​

JSON line shows or hides a line of each rule's raw JSON definition beneath its description in the table. The button is highlighted while the JSON lines are shown. The lines are shown when the page is first opened in a browser; the browser remembers the choice, which applies to the JSON line button on Notable Events and Cases Search as well.

Columns​

⚙ Columns opens a checklist of the table's columns. Ticking or clearing an entry shows or hides that column at once.

Columns menu open over the rule table, with Name, Category, Description, Tags, Active, and Last Updated ticked and Behavior, Event Type, Repository, and Behavior Filters cleared

ColumnShown by default
NameYes
CategoryYes
DescriptionYes, as a line beneath the rule's name
TagsYes
ActiveYes
BehaviorNo
Event TypeNo
RepositoryNo
Last UpdatedYes
Behavior FiltersNo

Rule Table​

Each row is one rule. With the default columns it shows the rule's Name, Category, Tags as chips, an Active switch, and Last Updated date and time, with the rule's description on a second line. Twenty-five rules are listed per page; the footer reports the range shown (for example 1–25 of 395) and the current page, with ‹ Prev and Next › buttons to move between pages.

Active Switch​

The Active switch enables or disables the rule. A blue switch is on; a grey switch is off. Flipping it saves the change immediately; there is no separate save step. A green notice confirms it: Eventwatch Bucket Status Updated for <rule name>.

Rule Detail Panel​

Click a rule's row to open its detail panel, which slides in over the right half of the page.

Rule detail panel for a repository rule, showing the View Rule, Clone, and Download JSON buttons and the Overview, Description, Tags &amp; Risks, Matching Behavior Filters, and Raw JSON sections

  • Header: the rule's name, with its category and the rule's origin beneath it, repository rule (read-only) for a rule supplied by a repository such as Fluency. On the right are the rule's on/off switch, which works like the table's Active switch, and the × that closes the panel.
  • View Rule: opens the rule itself.
  • Clone: starts a new rule from a copy of this one: the Add Behavior Rule wizard opens with the name <rule name>_clone and the rule's description, tags, and event type; Bucket Category starts empty.
  • Download JSON: saves the rule's JSON definition as <rule name>.json, and a green notice reads JSON File Downloaded.
  • OVERVIEW: Name, Category, Event Type, Behavior, Key Type (for example asset or username), Aggregation Type when the rule has one, Repository, and Last Updated.
  • DESCRIPTION: the rule's full description, including any reference links.
  • TAGS & RISKS: the rule's tags, followed by its risk labels highlighted in blue (for example ALERT_HIGH_CONFIDENCE).
  • MATCHING BEHAVIOR FILTERS: the number of behavior filters that reference the rule, and a list of them; No behavior filters reference this rule. when there are none.
  • RAW JSON: the rule's JSON definition, collapsed. Show expands it, and the copy icon beside it copies the JSON to the clipboard.

A rule of your own, created on this account rather than supplied by a repository, has no origin line under its category and no Repository row in OVERVIEW. Its buttons are Edit, Clone, Download JSON, and a red Delete:

  • Edit: opens the rule in the Update Behavior Rule wizard.
  • Delete: asks Are you sure you want to delete the behavior rule <rule name>? Once the rule is deleted, the panel closes, a green notice reads Successfully deleted behavior rule, and the rule leaves the table.

Create Rule​

Click + Create Rule to open the Add Behavior Rule dialog: Define the bucket, how events are selected, and the activity that raises a behavior. The dialog is a three-step wizard whose steps are shown across the top: 01 Bucket Definition, 02 Selection Criteria, and 03 Activity Performed.

Add Behavior Rule dialog on the Bucket Definition step, with Name, Description, Bucket Category, Tags, Event Type, and Search Profile fields and the Import Rule, Cancel, and Next buttons

The Bucket Definition step contains:

  • Name: required; letters, digits, _ and - only. Next refuses an empty name, or one with any other character such as a space, with Name is required and should contain only alphanumeric, _, - characters.
  • Description: multi-line text.
  • Bucket Category: free text.
  • Tags: a multi-select list (Add…) of tags, such as AD, AWS, AzureAD, CrowdStrike, and EntraID.
  • Event Type: a drop-down preset to event; the options are metaflow, event, and resource. Choosing resource adds a Resource Type drop-down (preset to None) below.
  • Search Profile: a drop-down preset to None, listing the saved event search profiles (see Search Facets), for example Default-SentinelOne, Default-O365_Exchange, and Default-AzureAD_SignIn.

At the bottom of the dialog, Import Rule loads an existing rule definition instead of building one field by field, Cancel closes the dialog, and Next moves to the next step. The × in the upper-right corner also closes the dialog. Once a step is passed, its number across the top turns into a check mark (✓ Bucket Definition).

Selection Criteria​

The Selection Criteria step chooses the events the rule reads:

  • Match All: a checkbox, unticked.
  • LVDB Query: a checkbox, unticked.
  • Event Filter, under QUERY: a text field for a selection query.
  • SEARCH FILTERS: the rule's search filters, one row each, and an + Add Search Filter button.

+ Add Search Filter opens the filter's editor in the step itself:

  • Name: required; the event field the filter tests, such as @fields.Operation.
  • Filter Type: a drop-down preset to field; the options are content, contains, startswith, endswith, regexp, field, entityinfo, exists, and feed.
  • Terms: the values to match (Type a value and press Enter). Each value becomes a chip with an × that removes it.
  • Exclude Field: a checkbox, unticked.

Save filter adds the filter to the list; it needs a field name and at least one term. Cancel closes the editor without adding one. While the editor is open, Next is greyed out. A saved filter reads as a sentence, for example @fields.Operation must be FilePreviewed OR FileDownloaded, with Edit and Delete at its right. Back returns to the previous step; Next moves on, with or without filters.

Selection Criteria step of the Add Behavior Rule wizard, with the Match All and LVDB Query checkboxes, the Event Filter field, and the search filter editor open with an empty Name, Filter Type set to field, the Terms field, the Exclude Field checkbox, and Cancel and Save filter buttons

Activity Performed​

The Activity Performed step defines the behavior the rule raises:

FieldControlDefault
Behavior NameThe rule's name, read-only.
Behavior TypeRequired. A drop-down: network access, account login, application activity, or security alert. The rule is not saved without one.Select a behavior…
DescriptionFree text. It can refer to an attribute by its alias, as {{.Username}}.Empty
Entity / KeyThe event field that identifies the entity, such as @fields.UserId.Empty
Key TypeA drop-down: username, asset, ip, mac address, application, and further key types such as AD_AUTO and SentinelOne.AgentID.username
RisksA multi-select list (Add…) of risk labels.None

Below the fields, three sections:

  • ATTRIBUTES: the event fields recorded with each behavior. + Add Attribute opens an editor with Field (the event field) and Alias (the name it is shown under), both required, and Cancel and Save attribute; with either left empty, Save attribute reports Field is required · Alias for field is required. A saved attribute reads <alias> ← <field>, for example Username ← @fields.UserId, with Edit and Delete.
  • CORRELATION RULES: + Add First-Occurrence Rule and + Add Aggregation Rule, each opening an editor described below. A saved correlation rule reads <name> · <type>, for example FilesAccessed · cardinality, with Edit and Delete.
  • SET AS ACTIVE RULE: a switch, on by default and labelled Active. Turned off, it reads Inactive (saved but not evaluated): the rule is saved but the platform does not evaluate it until it is switched on.

While an attribute or correlation-rule editor is open, Save is greyed out. Back returns to the previous step.

Activity Performed step of the Add Behavior Rule wizard, filled in: Behavior Type application activity, a description that refers to the Username and IP attributes, Entity / Key @fields.UserId, Key Type username, the Username and FileName attributes, the FilesAccessed cardinality correlation rule with the two add buttons below it, and the SET AS ACTIVE RULE switch turned off

Aggregation Rule​

+ Add Aggregation Rule opens the Aggregation rule editor, for a rule that triggers when an aggregate of the entity's events crosses a value within a window:

FieldControlDefault
TypeCount, Sum, or Cardinality.Sum
NameRequired. Text.Empty
DescriptionText.Empty
FieldRequired. A drop-down of __SIZE__ and the aliases of the attributes already added.Select a field…
RisksA multi-select list of risk labels, such as ALERT_SEVERITY_MEDIUM.None
Window Size1, 5, 10, 15, or 30.1
Window UnitMinutes, Hours, or Days.Hours
Match OperatorGreater Than, Less Than, or Between.Greater Than
ValueA number.0

Save rule adds it to CORRELATION RULES; with the name or field missing, it reports Name is required · Field is required. Cancel closes the editor without adding the rule.

Aggregation rule editor in the Activity Performed step, with Type Cardinality, the name FilesAccessed, a description, Field FileName, the ALERT_SEVERITY_MEDIUM risk, Window Size 1, Window Unit Hours, Match Operator Greater Than, and Value 20

First-Occurrence Rule​

+ Add First-Occurrence Rule opens the First-occurrence rule editor, for a rule that triggers when a value is seen for the first time:

  • Name: required.
  • Fields: required; the fields whose values are tracked (Type a value and press Enter).
  • Risks: a multi-select list of risk labels.
  • Global Scope, Local Scope, and Entity Scope: checkboxes; only Local Scope is ticked by default.
  • Window Size (default 10) and Window Unit (default Days), with the same options as for an aggregation rule.

Save rule adds it; with the name or fields missing, it reports Name is required · At least one field is required. Cancel closes the editor only, not the wizard.

Saving the Rule​

Save, on the Activity Performed step, creates the rule. Once it is saved, the dialog closes, a green notice reads Successfully added behavior rule, and the rule joins the table, active or inactive as SET AS ACTIVE RULE was set.

Update Behavior Rule​

Edit, in the detail panel of a rule of your own, opens the same three steps as Update Behavior Rule, filled in from the rule. Name is read-only; the other fields can be changed. The first step has no Import Rule; Cancel closes the wizard and Next moves on. The last step has Back and Save, and no Cancel.

Behavior Filters​

Click Behavior Filters to open the Behavior Filters page (/v2/configuration/behavior-filters), which lists the exceptions applied to behavior rules.

Behavior Filters page with its search field, Return to Rules and Add Wildcard Filter buttons, a filters panel with Behavior Rule, Action, and Status groups, and an empty filter table

The page is laid out like Behavior Rules:

  • A Back to Behavior Rules link above the title Behavior Filters and the subtitle Exceptions for Behavior Rules.
  • A search field (placeholder Search filters by name, rule, field, value…), a Return to Rules button that goes back to the Behavior Rules page, and + Add Wildcard Filter, which creates a new filter (see Add Wildcard Filter).
  • The filter count (for example 0 of 0 filters) with JSON line and ⚙ Columns buttons (see Filter Columns).
  • A FILTERS panel with Behavior Rule, Action, and Status groups. A group with no values reads No values in this window.
  • A table with ENABLED, NAME, DESCRIPTION, BEHAVIORS, and CREATED ON columns. When the account has no filters, the table reads No behavior filters match this search.

Filter Columns​

⚙ Columns on the Behavior Filters page opens a checklist of the filter table's columns, two of which are hidden by default:

ColumnShown by default
EnabledYes
NameYes
DescriptionYes
BehaviorsYes
ActionNo
CriteriaNo
Created OnYes

Behavior Filters page with the Columns checklist open, Enabled, Name, Description, Behaviors and Created On ticked and Action and Criteria unticked

Add Wildcard Filter​

+ Add Wildcard Filter opens the Add Behavior Filter dialog: Enter the behavior filter information to add to the system. It has three sections:

  • FILTER DEFINITION
    • Behavior Rule: greyed out, showing *.
    • Name: required.
    • Description: free text.
    • Action: a drop-down preset to Mask/Append Risks Only; the other option is Discard Matching Event.
    • Match All: a checkbox, unticked.
  • BEHAVIOR RISKS: two multi-select lists (Add…): Append Risks and Mask Risks.
  • SEARCH CRITERIA: an + Add Filter button.

The dialog ends with Cancel and Save; the × in its upper-right corner closes it. Save needs a name and at least one search criterion; with neither, it reports both at once: Filter Name is required · At least one search criteria is required.

Add Behavior Filter dialog with the Behavior Rule field showing an asterisk, an empty Name, Description, the Action drop-down set to Mask/Append Risks Only, the Match All checkbox, the Append Risks and Mask Risks lists, the + Add Filter button, and Cancel and Save