NotificationSettings

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. NotificationSettings contains the notification settings for a user.

JSON representation 
{
  "name": string,
  "canReceiveSystemNotifications": boolean,
  "canReceiveUserNotifications": boolean,
  "maxDaysToShowInFeed": integer,
  "eventBasedNotificationPreferences": {
    string: {
      object (NotificationPreference)
    },
    ...
  }
}
Fields
name

string

Output only. Identifier. The resource name of the notification settings. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarUsers/{legacySoarUser}/notificationSettings
canReceiveSystemNotifications

boolean

Required. Indicates whether the user can receive system notifications.
canReceiveUserNotifications

boolean

Required. Indicates whether the user can receive user-generated notifications.
maxDaysToShowInFeed

integer

Required. Specifies the maximum number of days notifications are shown in the user's feed. The acceptable range for the number is 2 to 7.
eventBasedNotificationPreferences

map (key: string, value: object (NotificationPreference))

Required. Maps predefined notification type strings to their specific notification preferences. Valid keys: "caseAssignment", "caseStatusChange", "caseComment", "task", "sharedItem", "manualAction", "playbookAction".

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

NotificationPreference

Contains email and push notification preferences for an event.

JSON representation 
{
  "emailEnabled": boolean,
  "pushEnabled": boolean
}
Fields
emailEnabled

boolean

Required. Specifies if email notifications are enabled for the event.
pushEnabled

boolean

Required. Specifies if push notifications are enabled for the event.