Newer Version Available

This content describes an older version of this product. View Latest

TenantSecurityNotificationRule

Represents an alert configured in Security Center to notify recipients of changes made to security settings. This object is available in API version 53.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field Details
MetricsType
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The type of data being collected.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the metric for which data is being collected.
NotificationRuleIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The ID of the alert that was triggered. This field is unique within your organization.
NotificationType
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The type of notification used for the alert. The options are:
  • Email
  • In-App
Operator
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The operator value for the change that triggered the alert. For example, greater than.
RecipientEmails
Type
textarea
Properties
Create, Nillable, Update
Description
The email addresses for the recipients of the alert details.
RuleName
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the custom alert that triggered the notification. This field is unique within your organization.
Status
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The status of the alert setting. The options are:
  • Active
  • Draft
  • Inactive
Threshold
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The threshold value of the change that will trigger the alert.
TriggerType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of trigger used to create an alert. The values are:
  • Always
  • On Change
Version
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The version number of the custom alert.