Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved descriptions for usage of is_alert. #1185

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions events/findings/data_security_finding.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@
"is_alert": {
"profile": null,
"group": "primary",
"description": "Indicates that the event is considered to be an alertable signal. For example, an <code>activity_id</code> of 'Create' could constitute an alertable signal and the value would be <code>true</code>, while 'Close' likely would not and either omit the attribute or set its value to <code>false</code>. Note that other events with the <code>security_control</code> profile may also be deemed alertable signals and may also carry <code>is_alert = true</code> attributes.",
"requirement": "recommended"
},
"resources": {
Expand Down
1 change: 1 addition & 0 deletions events/findings/detection_finding.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"is_alert": {
"profile": null,
"group": "primary",
"description": "Indicates that the event is considered to be an alertable signal. For example, an <code>activity_id</code> of 'Create' could constitute an alertable signal and the value would be <code>true</code>, while 'Close' likely would not and either omit the attribute or set its value to <code>false</code>. Note that other events with the <code>security_control</code> profile may also be deemed alertable signals and may also carry <code>is_alert = true</code> attributes.",
"requirement": "recommended"
},
"remediation": {
Expand Down
1 change: 1 addition & 0 deletions profiles/security_control.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"description": "The firewall rule that pertains to the control that triggered the event, if applicable."
},
"is_alert": {
"description": "Indicates that the event is considered to be an alertable signal. Should be set to <code>true</code> if <code>disposition_id = Alert</code> among other dispositions, and/or <code>risk_level_id</code> or <code>severity_id</code> of the event is elevated. Not all control events will be alertable, for example if <code>disposition_id = Exonerated</code> or <code>disposition_id = Allowed</code>.",
"requirement": "recommended"
},
"malware": {
Expand Down
Loading