REST Resource: projects.locations.instances.legacySoarUsers.userNotifications

Resource: UserNotification

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. UserNotification represents a notification that was sent to the user.

JSON representation 
{
  "name": string,
  "createdTime": string,
  "updatedTime": string,
  "recipient": string,
  "sender": string,
  "message": string,
  "context": {
    object (UserNotificationContext)
  },
  "notificationObjectType": enum (UserNotificationObjectType),
  "isRead": boolean
}
Fields
name

string

Identifier. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarUsers/{legacySoarUser}/userNotifications/{userNotificationId}
createdTime

string (int64 format)

Output only. The timestamp when the notification was created in milliseconds Unix time.
updatedTime

string (int64 format)

Output only. The timestamp when the notification was last updated in milliseconds Unix time.
recipient

string

Output only. The message receiver guid identifier.
sender

string

Output only. The message sender guid identifier.
message

string

Output only. User UserNotification message.
context

object (UserNotificationContext)

Output only. The user notification context that was used to create this notification message
notificationObjectType

enum (UserNotificationObjectType)

Output only. The user notification's associated object type.
isRead

boolean

Output only. Flag that indicates whether the user read(=saw) it or not.

UserNotificationContext

UserNotificationContext represents the context of the notification.

JSON representation 
{
  "message": string,
  "messageLinks": {
    string: {
      object (UserNotificationContextLink)
    },
    ...
  },
  "notificationCardLink": {
    object (UserNotificationContextLink)
  }
}
Fields
message

string

Output only. The message template without numbers or parameters.

UserNotificationLinkDestination

UserNotification link destination type

Enums
CASE Case link destination.
CASE_WALL Case wall link destination.
DASHBOARD Dashboard link destination.
GENERAL_TASK General task link destination.
ACTION_RESULT Action result link destination.
CASE_PLAYBOOK Case playbook link destination.
INCIDENT Incident link destination.
HOMEPAGE Homepage link destination.
REMOTE_AGENT Remote Agent link destination.

UserNotificationObjectType

UserNotificationObjectType represents the type of the object that the notification is associated with.

Enums
USER_NOTIFICATION_OBJECT_TYPE_UNSPECIFIED Unspecified object type.
CYBER_CASE Cyber case object type.
CASE_TASK Case task object type.
CASE_ASSIGNMENT Case assignment object type.
CASE_STATUS_CHANGE Case status change object type.
CASE_COMMENT Case comment object type.
SHARED_ITEM Shared item object type.
CASE_MANUAL_ACTION Case manual action object type.
PLAYBOOK_ACTION Playbook action object type.
CASE_ATTACHMENT Case attachment object type.
CASE_TAG Case tag object type.
REMOTE_AGENT Remote agent object type.

Methods

count

 Counts UserNotifications for a given user.

get

 Get a User UserNotification.

list

 Lists User Notifications.

markAsRead

 Marks UserNotification as read.