OBJECT

SecurityRule

link GraphQL Schema definition

  • type SecurityRule implements HyperLinked, Node, NodeVersion {
  • # Category of the generated finding
  • category: SecurityFindingCategory! @deprecated( reason: "category is being replaced by policyClass" )
  • changeLog: SecurityChangeLogConnection!
  • # Cloud provider of this policy
  • cloudProvider: SecurityCloudProvider!
  • # Get list of controls related to this rule.
  • controls: SecurityControlsConnection
  • # The author of the rule
  • createdBy: SecurityUserInfo
  • # The time this rule was created
  • creationTime: DateTime!
  • # Brief description about this rule
  • description: LocalizedString
  • # Name of this rule
  • displayName: LocalizedString!
  • # Indicated the rule is enabled for this organization
  • enabled: Boolean!
  • # Get list of current findings generated from this rule.
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # filter: Optional filter
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # sort: Sort order for results in the connection
  • findings(
  • after: String,
  • filter: SecurityFindingsFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityFindingsConnection!
  • # Get list of frameworks related to this rule.
  • frameworks: SecurityFrameworksConnection
  • # Optional hyperlink(s) to visualize specific rule data in detail
  • hyperlinks: [HyperLink!]
  • # Node-compatible opaque global identifier
  • id: ID!
  • # The last time this rule was successfully updated
  • lastUpdateTime: DateTime!
  • # Opaque version string for this graph node instance
  • nodeVersion: ID!
  • # Classes of the rule
  • policyClass: [SecurityPolicyClass!]
  • # Cloud provider of this rule
  • provider: String! @deprecated( reason: "Use cloudProvider field instead" )
  • # Resources related to the rule
  • resources: [SecurityResource!]
  • ruleId: String!
  • # Specific cloud provider service that is monitored by this rule
  • service: String!
  • # The severity of the generated finding e.g. Critical, High, Medium or Low
  • severity: SecurityFindingSeverity!
  • # Source of the generated finding. Accepted only Native and Custom.
  • source: SecurityComplianceSource!
  • # Suggested action for a rule.
  • suggestedAction: LocalizedString
  • # Get list of tags related to this rule.
  • #
  • # Arguments
  • # key: [Not documented]
  • tags(key: [String!]): [Tag!]
  • # List of triggers for this rule
  • triggers: [SecurityTrigger!]
  • # Type of the generated finding e.g. Violation, Threat, Anomaly
  • type: SecurityFindingType!
  • # Query used to detect violations in customer's cloud account inventory state
  • violationQuery: SecurityRuleQuery!
  • # Query used for visualization in customer's cloud account inventory
  • visualizationQuery: SecurityRuleQuery
  • }