OBJECT

SecurityAlert

link GraphQL Schema definition

  • type SecurityAlert implements Node, NodeVersion {
  • # Node-compatible opaque global identifier
  • alertId: String!
  • context: SecurityContext
  • # The Alert Author
  • createdBy: SecurityUserInfo!
  • # Timestamp for the creation of the resource in date-time format. Field is
  • # readonly.
  • createdTime: DateTime!
  • # The list of filters that determines when a new finding will trigger the alert.
  • # If a new finding is generated it will trigger the alert only if it matches all
  • # the criteria.
  • criteria: [SecurityCriterion!]!
  • # Enabled turns the alert on/off. If enabled=false new findings wouldn't trigger
  • # the alert.
  • enabled: Boolean!
  • # Node-compatible opaque global identifier
  • id: ID!
  • # Integrations used by this Alert
  • integrations: [SecurityAlertIntegrationInfo!]!
  • # Timestamp for the last update of the resource in date-time format. Field is
  • # readonly.
  • lastUpdatedTime: DateTime!
  • # Count for triggered alerts in limit window. After this count the alert will be
  • # switched to summary.
  • limitCount: Int
  • # Length of alert limit window in seconds.
  • limitSeconds: Int
  • # A list of Management Endpoints that this Alert is active for.
  • managementEndpoints: [ManagementEndpoint!]
  • # Human-readable message to be sent along the finding details
  • message: String
  • # Name of the alert resource
  • name: String!
  • # Opaque version string for this graph node instance
  • nodeVersion: ID!
  • # IDs of the projects the alert resource is part of (the alert's context).
  • # If the list is empty the alert in the organization context (accessible for the
  • # entire org).
  • projectIds: [String!]
  • # Status holds details about the healthiness of the alert resource.
  • status: SecurityAlertStatus!
  • # Defines which finding property to make the summary for the alert.
  • summarizeByFindingProperty: String
  • # The summary alert period in minutes.
  • summarizeMinutes: Int
  • # Alert Type
  • type: SecurityAlertType!
  • }