diff --git a/events/findings/data_security_finding.json b/events/findings/data_security_finding.json index f6e9fb4cc..780dde1e0 100644 --- a/events/findings/data_security_finding.json +++ b/events/findings/data_security_finding.json @@ -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 activity_id of 'Create' could constitute an alertable signal and the value would be true, while 'Close' likely would not and either omit the attribute or set its value to false. Note that other events with the security_control profile may also be deemed alertable signals and may also carry is_alert = true attributes.", "requirement": "recommended" }, "resources": { diff --git a/events/findings/detection_finding.json b/events/findings/detection_finding.json index f58911840..bd5e1f887 100644 --- a/events/findings/detection_finding.json +++ b/events/findings/detection_finding.json @@ -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 activity_id of 'Create' could constitute an alertable signal and the value would be true, while 'Close' likely would not and either omit the attribute or set its value to false. Note that other events with the security_control profile may also be deemed alertable signals and may also carry is_alert = true attributes.", "requirement": "recommended" }, "remediation": { diff --git a/profiles/security_control.json b/profiles/security_control.json index 7ef74e7da..6aeaa9b72 100644 --- a/profiles/security_control.json +++ b/profiles/security_control.json @@ -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 true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.", "requirement": "recommended" }, "malware": {