OBJECT

FindingNotificationRule

link GraphQL Schema definition

  • type FindingNotificationRule implements Node, NodeVersion, NotificationRule {
  • # Notification Rule context
  • context: NotificationTargetContext
  • # The Notification Rule Author
  • createdBy: User!
  • # Creation time of the Notification Rule. Field is readonly.
  • creationTime: DateTime!
  • # The list of filters that determines when a new finding will trigger the
  • # Notification Rule.
  • # If a new finding is generated it will trigger the Notification Rule only if it
  • # matches all the criteria.
  • criteria: [FindingCriterion!]!
  • # List of CSP Project Entities that this notification rule is scoped
  • # If the list is empty the Notification Rule is assumed to be in the organization
  • # context (accessible for the entire org).
  • cspProjectEntities: [Entity!]
  • # List of email addresses the notifications of this rule needs to be delivered to.
  • # Should be provided when notification target type is EMAIL
  • emailAddresses: [String!]
  • # Enabled turns the Notification Rule on/off. If enabled=false new findings
  • # wouldn't trigger the Notification Rule.
  • enabled: Boolean!
  • # Node-compatible opaque global identifier
  • id: ID!
  • # Last update time of the Notification Rule. Field is readonly.
  • lastUpdateTime: DateTime!
  • # A list of Management Endpoints that this Notification Rule is active for.
  • managementEndpoints: [ManagementEndpoint!]
  • # Human-readable message to be sent along the finding details
  • message: String
  • # Name of the Notification Rule
  • name: String!
  • # Opaque version string for this graph node instance
  • nodeVersion: ID!
  • # Notification Rule Identifier
  • notificationRuleId: String!
  • # List of notification targets that this notification needs to be delivered
  • notificationTargets: [FindingNotificationTarget!]
  • # IDs of the projects the Notification Rule is part of (the Notification Rule's
  • # context).
  • # If the list is empty the Notification Rule is assumed to be in the organization
  • # context (accessible for the entire org).
  • projectIds: [String!]
  • # Provider name of the notification rule, this will be 'findings'
  • provider: String!
  • # Status holds details about the healthiness of the Notification Rule resource.
  • status: FindingNotificationRuleStatusDetails!
  • # Defines which finding property to make the summary for the Notification Rule.
  • summarizeByFindingProperty: FindingNotificationRuleSummarizedBy
  • # The summary Notification Rule period in minutes.
  • summarizeMinutes: Int
  • # The address, other than email ids, used for this Notification Rule, for example,
  • # these could contain channel name for slack target
  • # Note: These addresses are in the order of the Notification targets, as some
  • # targets dont have addresses, some of the these will be null.
  • targetAddress: [String]
  • # Notification Rule Type
  • type: FindingNotificationRuleType!
  • }

link Require by