Incidents API Definitions

actorIdType
optional

Filter events based on the inclusive actor identifier type recorded. Case sensitive

enum (USER, IP_ADDRESS)

actorIds
optional

List of inclusive actor identifiers that are either user name or IP address (may be tokenized depending on product configuration), which will be applied to limit response. Empty list implies all users and IP addresses for authenticated tenant.

< string > array

deviceTypes
optional

Filter events based on selected list of inclusive device types. Default (empty) :== all. Case sensitive values :== [ AndroidMobile | BlackberryMobile | iPadMobile | iPhoneMobile | iPodMobile | JavaApplication | LinuxDesktop | MacDesktop | PlaystationGaming | SymbianMobile | WiiGaming | WindowsDesktop | WindowsPhoneMobile | Unknown ]

< string > array

endTime
optional

Filter for ending date-time, exclusive. Default (empty) :== now. Format :== yyyy-mm-ddThh:mm:ss[Z([+-]hh:mm)]
Example: "2016-06-15T08:00:00.000Z"

string (date-time)

incidentCriteria
optional

IncidentCriteria

permissionType
optional

Filter events based on whether the event was allowed or not. Case sensitive.

enum (ALLOWED, DENIED)

protocolTypes
optional

Filter events based on list of inclusive protocol used. The values for protocols are kept in a database table; here are some case sensitive values :== [ dns | http | https | ntp | Unknown ]

< string > array

serviceCategories
optional

Filter events based on list of inclusive service categories used. The values for categories are kept in a database table; here are some case sensitive values :== [ Backup and Archiving | Business Intelligence | Cloud Infrastructure | Cloud Storage | Collaboration | Content Sharing | CRM | Development | e-Commerce | ERP | Finance | Health Care | HR | IaaS Admin Console | IT Services | Legal | Logistics | Marketing | Media | Networking | Procurement | Project Management | Security | Service Desk and Support | Service Proxy | Social Media | Tracking | Uncategorized | Virtual Data Rooms | Web Application ]

< string > array

serviceNames
optional

List of inclusive service names that will be applied to restrict the response. Empty list implies all services of the authenticated tenant.

< string > array

serviceRiskMaximum
optional

Filter events with service risk scores at or greater than this value, inclusive. Higher values reflect more risk. Value must be >= serviceRiskMinimum.
Default: 10
Minimum value: 0
Maximum value: 10

integer (int32)

serviceRiskMinimum
optional

Filter events with service risk scores at or less than this value, inclusive. Higher values reflect more risk. Value must be <= serviceRiskMaximum.
Default: 0
Minimum value: 0
Maximum value: 10

integer (int32)

startTime
optional

Filter for starting date-time, inclusive. Default (empty) :== now. Format :== yyyy-mm-ddThh:mm:ss[Z([+-]hh:mm)]
Example: "2016-06-15T00:00:00.000Z"
IMPORTANT: Although the API limits 10,000 responses, incidents with the same start time are never split into two API responses. Any subsequent incidents that have the identical start time as the 10,000th incident are returned in the same API response. See Managing API Responses.

string (date-time)

uploadDataMinimum
optional

Filter events to those that have at least upload data of this minimum size, inclusive.

integer (int64)

userRiskMaximum
optional

Filter events with user risk scores at or greater than this value, inclusive. Higher values reflect more risk. Value must be >= userRiskMinimum.
Default: 10
Minimum value: 0
Maximum value: 10

integer (int32)

userRiskMinimum
optional

Filter events with user risk scores at or less than this value, inclusive. Higher values reflect more risk. Value must be <= userRiskMaximum.
Default: 0
Minimum value: 0
Maximum value: 10

integer (int32)

code
optional

HTTP status codes :== 2xx success, 4xx client error, or 5xx server error.
Minimum value: 50
Maximum value: 600
Example: 400

integer (int32)

details
optional

Additional smaller errors that caused the main error.

< Error > array

message
optional

English equivalence of HTTP status code used.
Example: "Missing the required parameter 'criteria' when calling getUsersUsage"

string

target
optional

Optional comma-separated field name(s) with issue to resolve.
Example: "phoneNumber"

string

activityNames
optional

List of names of activities that caused the incident.
Example: "Upload Over Time"

< string > array

actorId
optional

Actor identifier that was involved in the incident which may either be user name or IP address (may be tokenized depending on product configuration); see actorIdType.
Example: "sam@corp.com"

string

actorIdType
optional

Indicates if the actor identifier is user name or IP address.

enum (User, IpAddress)

incidentGroup
optional

Concatenated incidentType.category.name fields.
Example: "Threat.InsiderThreat.HighVolumeDataExfiltration"

string

incidentId
optional

Unique identifier for this particular incident, which includes a three-letter prefix and dash to identify the type of incident:

SHW – Shadow Anomaly
ANO – Sanctioned Anomaly
THR – Threat
APP – Connected Apps Policy Incident
AUD – Audit Policy Incident
CAP – Cloud Access Policy Incident
DLP – Data Loss Policy Incident
EPO – ePO Violation
MAL – Malware Violation
VUL – Vulnerability Policy Incident

string

incidentRiskScore
optional

Risk score associated with the incident.

number (double)

incidentRiskSeverity
optional

Indication showing amount of risk involved in the incident. Values ::= [ low | medium | high ]

string

information
optional

List of other key:value pairs that are associated with the incident. For a list of the keys, use the queryIncidentInformationKeys command.

< KeyValue > array

responses
optional

List of actionable responses for the incident.
Example: "Quarantine"

< string > array

serviceNames
optional

List of names of services that were involved in the incident.
Example: "google"

< string > array

status
optional

Current state of incident. Values ::= [ new | opened | false positive | resolved | suppressed | archived ]

string

timeCreated
optional

Time the incident was created. Format :== yyyy-mm-ddThh:mm:ss.sssZ
Example: "2016-06-15T00:00:00.000Z"

string (date-time)

timeModified
optional

Time the incident was last modified. Start time and end time filters work with this modified time. Format :== yyyy-mm-ddThh:mm:ss.sssZ
Example: "2016-06-15T00:00:00.000Z"

string (date-time)

category
optional

Qualifying category within incidentType; categories are only valid for parenthesized incidentType. Case sensitive values ::= [ Access (Alert) | Admin (Alert) | Audit (Alert) | CompromisedAccount (Threat) | Data (Alert) | InsiderThreat (Threat) | Policy (Alert) | PrivilegeAccess (Threat) | Vulnerability (Alert) ]

string

incidentType
optional

A type of incident. Incident type 'Event' is not yet supported. Case sensitive values ::= [ Alert | Event* | Threat ]

string

categories
optional

Inclusively filter incidents based on a incident group of incidentType and category.

< IncidentCategory > array

product
optional

Inclusively filter incidents based on the product.
Default : "SANCTIONED"

enum (SANCTIONED, SHADOW)

fields
optional

Inclusively filter sanctioned incidents based on incident fields. Multiple fields are ANDed and multiple values are ORed.

The only field names currently supported are policyName, policyId, contentItemName, contentItemId, and status.

Only built-in status values are supported for the filter query.

< string, < string > array > map

Example

"incidentCriteria": {
    "fields": {
        "policyName": ["PII", "Encrypted files"]
    }
}

informationKeys
optional

Example: { "accountId" : "account id that was being audited" }

< KeyValue > array

type
optional

Type of incident. Values :== [ AuditViolation (Alert.Audit…) | PolicyViolation (Alert.Policy.Dlp) | SanctionedAnomaly (Alert…) | ShadowAnomaly (Alert…) | Threat (Threat…) | VulnerabilityViolation (Alert.Policy.Vulnerability) ]
Example: "AuditViolation"

string

incidents
optional

< Incident > array

responseInfo
optional

ResponseInfo