OBJECT

SecurityQuery

Query the security subsystem

link GraphQL Schema definition

  • type SecurityQuery {
  • # Aggregate security alerts
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # filter: Optional filter
  • aggregateAlerts(
  • aggregations: [SecurityAggregationInput!]!,
  • filter: SecurityAlertsFilterInput
  • ): SecurityAggregations! @deprecated( reason: "Use notificationQuery.notificationRulesQuery.notificationRulesProviders.findings.aggregateFindingNotificationRules" )
  • # Aggregate security findings
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # filter: Optional filter
  • aggregateFindings(
  • aggregations: [SecurityAggregationInput!]!,
  • filter: SecurityFindingsFilterInput
  • ): SecurityAggregations! @deprecated( reason: "Deprecated, please use findingQuery -> aggregateFindings instead!" )
  • # Aggregate security findings sources
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # filter: Optional filter
  • aggregateFindingsSources(
  • aggregations: [SecurityAggregationInput!]!,
  • filter: SecurityFindingsSourcesFilterInput
  • ): SecurityAggregations!
  • # Aggregate security integrations
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # filter: Optional filter
  • aggregateIntegrations(
  • aggregations: [SecurityAggregationInput!]!,
  • filter: SecurityIntegrationsFilterInput
  • ): SecurityAggregations! @deprecated( reason: "Use notificationQuery.notificationRulesQuery.notificationTargetsProviders.findings.aggregateNotificationTargets" )
  • # Aggregate security rules
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # filter: Optional filter
  • aggregateRules(
  • aggregations: [SecurityAggregationInput!]!,
  • filter: SecurityRulesFilterInput
  • ): SecurityAggregations!
  • # Query configured Alerts
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # 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: [Not documented]
  • queryAlerts(
  • after: String,
  • filter: SecurityAlertsFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityAlertsConnection! @deprecated( reason: "Use notificationQuery.notificationRulesQuery.notificationRulesProviders.findings.queryNotificationRules" )
  • # Query security compliance controls
  • #
  • # Arguments
  • # filter: Optional filter
  • queryControls(filter: SecurityControlsFilterInput): SecurityControlsConnection!
  • # Query Feature Flags
  • queryFeatureFlags: SecurityFeatureFlags!
  • # Query Findings Source Methods
  • queryFindingSourcesMethods: SecurityFindingsSourceMethodsConnection!
  • # Query security findings
  • #
  • # 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
  • queryFindings(
  • after: String,
  • filter: SecurityFindingsFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityFindingsConnection! @deprecated( reason: "Deprecated, please use findingQuery -> queryFindings instead!" )
  • # Query security findings sources
  • #
  • # 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
  • queryFindingsSources(
  • after: String,
  • filter: SecurityFindingsSourcesFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityFindingsSourcesConnection!
  • # Query security compliance frameworks
  • #
  • # Arguments
  • # filter: Optional filter
  • queryFrameworks(filter: SecurityFrameworkFilterInput): SecurityFrameworksConnection!
  • # Query security compliance groups
  • #
  • # Arguments
  • # filter: Optional filter
  • queryGroups(filter: SecurityGroupFilterInput): SecurityGroupsConnection!
  • # Query security integration methods
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • queryIntegrationMethods: SecurityIntegrationMethodsConnection! @deprecated( reason: "Use notificationQuery.notificationRulesQuery.notificationTargetsProviders.findings.queryNotificationTargetTypes" )
  • # Query security integrations
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # 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
  • queryIntegrations(
  • after: String,
  • filter: SecurityIntegrationsFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityIntegrationsConnection! @deprecated( reason: "Use notificationQuery.notificationRulesQuery.notificationTargetsProviders.findings.queryNotificationTargets" )
  • # Query user permissions
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • queryPermissions: SecurityUserPermissions!
  • # Query Entity Impacts for a Security Policy
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # input: [Not documented]
  • queryPolicyImpactedEntities(
  • input: SecurityPolicyImpactedEntitiesInput
  • ): SecurityPolicyImpactedEntities
  • # Query Report Configurations
  • #
  • # 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: [Not documented]
  • queryReportConfigurations(
  • after: String,
  • filter: SecurityReportConfigurationFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityReportConfigurationConnection!
  • # Query All Report Types.
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • queryReportTypes: [SecurityReportTypeInfo!] @deprecated( reason: "Use findingQuery.queryReportTypes" )
  • # Query Reports
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # 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: [Not documented]
  • queryReports(
  • after: String,
  • filter: SecurityReportFilterInput,
  • first: Int,
  • sort: [QuerySort!]
  • ): SecurityReportConnection! @deprecated( reason: "Use findingQuery.queryReports" )
  • # Query security rules
  • #
  • # 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
  • # search: Optional search query to filter the rules
  • # sort: Sort order for results in the connection
  • queryRules(
  • after: String,
  • filter: SecurityRulesFilterInput,
  • first: Int,
  • search: String,
  • sort: [QuerySort!]
  • ): SecurityRulesConnection!
  • # Query security findings suppressions
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • #
  • # 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
  • # search: Optional search
  • # sort: Sort order for results in the connection
  • # Supported fields: type, status, projectIds, expiration, creationTime,
  • # lastUpdateTime, updateRequest.status, status.lastUpdatedTime
  • querySuppressions(
  • after: String,
  • filter: SecuritySuppressionsFilterInput,
  • first: Int,
  • search: String,
  • sort: [QuerySort!]
  • ): SecuritySuppressionsConnection!
  • # Query suppressions reason template
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • querySuppressionsTemplate: SecuritySuppressionsTemplate
  • }

link Require by