afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/TenantSecurityNotification.json

85 lines
3.6 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects"
],
"title": "TenantSecurityNotification - Data API",
"description": "Stores information about notifications that were triggered in Security Center as a function of the Alerts feature. For more information, see Create Alerts for Security Changes. This object is available to Security Center subscribers in API version 54.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"MetricCount": {
"type": "int",
"properties": "Filter, Group, Sort",
"description": "The metric count that triggered the notification."
},
"MetricIdentifier": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The ID of the type of metric that was counted."
},
"MetricsType": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The metric for which the notification was sent."
},
"Name": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The name of the triggered notification rule."
},
"NotificationDate": {
"type": "dateTime",
"properties": "Filter, Sort",
"description": "The date and time that the notification was sent."
},
"NotificationType": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The type of notification sent. For example, a Chatter feed or push notification."
},
"Operator": {
"type": "string",
"properties": "Filter, Group, idLookup, Nillable, Sort",
"description": "The quantity of metrics used to measure."
},
"RecipientEmails": {
"type": "textarea",
"properties": "Nillable",
"description": "The email addresses of the recipients who receive security notifications."
},
"RuleName": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "The name of the notification rule."
},
"Tenant": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The ID of the tenant for which the notification was triggered."
},
"TenantName": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The org name of the tenant for which the notification was triggered."
},
"Threshold": {
"type": "int",
"properties": "Filter, Group, idLookup, Nillable, Sort",
"description": "The threshold value that triggered the notification."
},
"TriggerType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of trigger that set off the notification. For example, a security change was made."
}
},
"special_access_rules": "This object is read-only.",
"associated_objects": "This object has these associated objects. If the API version isnt specified, its available in the same API versions as this object. Otherwise, its available in the specified API version and later.\n\n- **TenantSecurityNotificationChangeEvent**: Change events are available for the object.\n- **TenantSecurityNotificationFeed**: Feed tracking is available for the object.\n- **TenantSecurityNotificationHistory**: History is available for tracked fields of the object.\n- **TenantSecurityNotificationOwnerSharingRule**: Sharing rules are available for the object.\n- **TenantSecurityNotificationShare**: Sharing is available for the object."
}