HashIncidentsFields

Hash fields from the incident list. Search for incidents by arguments with an option to hash some of its fields.

python · Machine Learning

Details

IDHashIncidentsFields
Languagepython
From Version5.0.0
Docker Imagedemisto/python3:3.12.8.3296088
Tagsincidents ml

README

Hash fields from the incident list.
Search for incidents by arguments with an option to hash some of its fields.

Script Data


Name Description
Script Type python3
Tags incidents, ml
Cortex XSOAR Version 5.0.0

Inputs


Argument Name Description
query Additional text by which to query incidents.
incidentTypes A comma-separated list of incident types by which to filter.
fromDate The start date by which to filter incidents. Date format will be the same as in the incidents query page, for example: “3 days ago”, ““2019-01-01T00:00:00 +0200”).
toDate The end date by which to filter incidents. Date format will be the same as in the incidents query page, for example: “3 days ago”, ““2019-01-01T00:00:00 +0200”).
limit The maximum number of incidents to fetch. The default value is 3000.
timeField The incident field to specify for the date range. Can be “created” or “modified”. The default is “created”.
NonEmptyFields A comma-separated list of non-empty value incident field names by which to filter incidents.
outputFormat The output file format.
populateFields A comma-separated list of fields in the object to poplulate.
fieldsToHash A comma-separated list of fields to hash. Support wildcards.
contextKeys A comma-separated list of context keys to keep.
removeLabels Remove incident labels
unPopulateFields A comma-separated list of fields in the object to un-poplulate.
addRandomSalt Random salt to the hash function

Outputs


Path Description Type
HashIncidentsFields.Filename The output file name. String
HashIncidentsFields.FileFormat The output file format. String
args:
- description: Additional text by which to query incidents.
  name: query
- description: A comma-separated list of incident types by which to filter.
  name: incidentTypes
- description: 'The start date by which to filter incidents. Date format will be the same as in the incidents query page, for example: "3 days ago", ""2019-01-01T00:00:00 +0200").'
  name: fromDate
- description: 'The end date by which to filter incidents. Date format will be the same as in the incidents query page, for example: "3 days ago", ""2019-01-01T00:00:00 +0200").'
  name: toDate
- defaultValue: '3000'
  description: The maximum number of incidents to fetch. The default value is 3000.
  name: limit
- auto: PREDEFINED
  defaultValue: created
  description: The incident field to specify for the date range. Can be "created" or "modified". The default is "created".
  name: timeField
  predefined:
  - created
  - modified
- description: A comma-separated list of non-empty value incident field names by which to filter incidents.
  name: NonEmptyFields
- auto: PREDEFINED
  defaultValue: json
  description: The output file format.
  name: outputFormat
  predefined:
  - json
  - pickle
- description: A comma-separated list of fields in the object to poplulate.
  name: populateFields
- auto: PREDEFINED
  description: A comma-separated list of fields to hash. Support wildcards.
  name: fieldsToHash
- description: A comma-separated list of context keys to keep.
  name: contextKeys
- auto: PREDEFINED
  defaultValue: 'false'
  description: Remove incident labels.
  name: removeLabels
  predefined:
  - 'true'
  - 'false'
- description: A comma-separated list of fields in the object to un-poplulate.
  name: unPopulateFields
- description: Random salt to the hash function.
  name: addRandomSalt
comment: |-
  Hash fields from the incident list.
  Search for incidents by arguments with an option to hash some of its fields.
commonfields:
  id: HashIncidentsFields
  version: -1
name: HashIncidentsFields
outputs:
- contextPath: HashIncidentsFields.Filename
  description: The output file name.
  type: String
- contextPath: HashIncidentsFields.FileFormat
  description: The output file format.
  type: String
script: '-'
subtype: python3
tags:
- incidents
- ml
timeout: '0'
type: python
dockerimage: demisto/python3:3.12.8.3296088
tests:
- hashIncidentFields-test
fromversion: 5.0.0