Class SecurityMonitoringStandardRulePayload

The payload of a rule.

Hierarchy

  • SecurityMonitoringStandardRulePayload

Constructors

constructor

Properties

additionalProperties? cases customMessage? customName? filters? groupSignalsBy? hasExtendedTitle? isEnabled message name options queries referenceTables? tags? thirdPartyCases? type?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

cases

cases: SecurityMonitoringRuleCaseCreate[]

Cases for generating signals.

Optional customMessage

customMessage?: string

Custom/Overridden message for generated signals (used in case of Default rule update).

Optional customName

customName?: string

Custom/Overridden name of the rule (used in case of Default rule update).

Optional filters

filters?: SecurityMonitoringFilter[]

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

Optional groupSignalsBy

groupSignalsBy?: string[]

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

Optional hasExtendedTitle

hasExtendedTitle?: boolean

Whether the notifications include the triggering group-by values in their title.

isEnabled

isEnabled: boolean

Whether the rule is enabled.

message

message: string

Message for generated signals.

name

name: string

The name of the rule.

options

options: SecurityMonitoringRuleOptions

Options.

queries

queries: SecurityMonitoringStandardRuleQuery[]

Queries for selecting logs which are part of the rule.

Optional referenceTables

referenceTables?: SecurityMonitoringReferenceTable[]

Reference tables for the rule.

Optional tags

tags?: string[]

Tags for generated signals.

Optional thirdPartyCases

thirdPartyCases?: SecurityMonitoringThirdPartyRuleCaseCreate[]

Cases for generating signals from third-party rules. Only available for third-party rules.

Optional type

type?: SecurityMonitoringRuleTypeCreate

The rule type.

Settings

Member Visibility

Theme

Generated using TypeDoc