TenantSecurityNotificationRule

Stores an alert configured in the Security Center Alerts feature to notify recipients of changes made to security settings. For more information, see Create Alerts for Security Changes. This object is available to Security Center subscribers in API version 53.0 and later.

Supported Calls

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

Special Access Rules

This object is read/write.

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 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 that triggered the alert.
TriggerType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of trigger used for the 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.

Associated Objects

This object has these associated objects. If the API version isn’t specified, it’s available in the same API versions as this object. Otherwise, it’s available in the specified API version and later.

TenantSecurityNotificationRuleChangeEvent
Change events are available for the object.
TenantSecurityNotificationRuleFeed
Feed tracking is available for the object.
TenantSecurityNotificationRuleHistory
History is available for tracked fields of the object.
TenantSecurityNotificationRuleOwnerSharingRule
Sharing rules are available for the object.
TenantSecurityNotificationRuleShare
Sharing is available for the object.