SensorScope type | Wartiva GraphQL API

An organization's rule for which Sensor probes may run against which devices. A scope lists the sensors it enables and up to four filters (IP protocol and address class, location, networks, and number of endpoints on a network). A device IP passes a scope only when every enabled filter allows it; multicast addresses never pass. The sensors allowed on a device are the union across all enabled scopes. Each organization has a vendor-maintained default scope, created automatically, whose sensor list follows the vendor defaults and which can only be enabled or disabled. List an organization's scopes, including disabled ones, with sensorScopes.

Fields

Field Name	Description
`id` - `ID!`	The unique identifier for this SensorScope.
`orgId` - `OrganizationId!`	The id of the Organization this scope belongs to.
`enabled` - `Boolean!`	If disabled this scope will not be applied to any Networks or Devices.
`isDefault` - `Boolean!`	If true this is the vendor default scope and modifications except enabling or disabling are not allowed.
`name` - `String!`	The name for this scope.
`description` - `String!`	Describes the purpose of this scope.
`autoAddNewSensors` - `Boolean`	If true then new sensors released by the vendor will be automatically enabled by this scope. When false, they are added to disabledSensors instead.
`sensors` - `[Sensor!]`	The Sensors enabled in this scope.
`disabledSensors` - `[Sensor!]`	The Sensors disabled in this scope. A sensor listed here is not re-enabled when the vendor defaults change.
`filterIpProtocol` - `SensorFilterIpProtocol!`	A filter considering IP protocol when determining if any sensors enabled by this scope apply to a Device or Network.
`filterLocations` - `SensorFilterLocations!`	A filter considering the geographic location when determining if any sensors enabled by this scope apply to a Device or Network.
`filterNetworks` - `SensorFilterNetworks!`	A filter applying this scope to defined Networks.
`filterNumEndpoints` - `SensorFilterNumEndpoints!`	A filter applying this scope only to Networks that have a certain number of endpoints connected.
`created` - `Time!`	The time this scope was first created.
`lastUpdateFromDefault` - `Time`	The time this scope was last updated from the vendor default if applicable.
`lastUpdateByUser` - `Time`	The time this scope was last updated by a user.
`defaultScopeVersion` - `Int`	The version of the vendor default scope last updated from.

Used by

SensorScopesPayload type: Payload wrapper for a list of SensorScope results.

Example

{
  "id": 4,
  "orgId": "615f3b3b28284380e28a7342",
  "enabled": false,
  "isDefault": true,
  "name": "xyz789",
  "description": "abc123",
  "autoAddNewSensors": true,
  "sensors": [Sensor],
  "disabledSensors": [Sensor],
  "filterIpProtocol": SensorFilterIpProtocol,
  "filterLocations": SensorFilterLocations,
  "filterNetworks": SensorFilterNetworks,
  "filterNumEndpoints": SensorFilterNumEndpoints,
  "created": "2021-10-07T18:23:25.829Z",
  "lastUpdateFromDefault": "2021-10-07T18:23:25.829Z",
  "lastUpdateByUser": "2021-10-07T18:23:25.829Z",
  "defaultScopeVersion": 123
}