---
schema_version: "1"
id: 3f70b3821d14f4061204273bfa90855546b38706c61de0cc54eb3718d1ccb247
title: TenantSecurityNotificationRule
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_tenantsecuritynotificationrule.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantsecuritynotificationrule.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: f5447686b35bb8ec2d5bd795b8131d401d410018cbe4567a045e236effc23334
description: 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.
---
# 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](https://help.salesforce.com/s/articleView?id=xcloud.security_center_create_alerts.htm&type=5&language=en_US). 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, 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, 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")

Change events are available for the object.

[TenantSecurityNotificationRuleFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[TenantSecurityNotificationRuleHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.

[TenantSecurityNotificationRuleOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")

Sharing rules are available for the object.

[TenantSecurityNotificationRuleShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.