pycti.entities.opencti_incident
- class pycti.entities.opencti_incident.Incident(opencti)[source]
Main Incident class for OpenCTI
Manages security incidents in the OpenCTI platform.
- Parameters:
opencti (OpenCTIApiClient) – instance of
OpenCTIApiClient
- __init__(opencti)[source]
Initialize the Incident instance.
- Parameters:
opencti (OpenCTIApiClient) – OpenCTI API client instance
- create(**kwargs)[source]
Create an Incident object.
- Parameters:
name (str) – the name of the Incident (required)
stix_id (str) – (optional) the STIX ID
createdBy (str) – (optional) the author ID
objectMarking (list) – (optional) list of marking definition IDs
objectLabel (list) – (optional) list of label IDs
externalReferences (list) – (optional) list of external reference IDs
revoked (bool) – (optional) whether the incident is revoked
confidence (int) – (optional) confidence level (0-100)
lang (str) – (optional) language
created (str) – (optional) creation date
modified (str) – (optional) modification date
description (str) – (optional) description
aliases (list) – (optional) list of aliases
first_seen (str) – (optional) first seen date
last_seen (str) – (optional) last seen date
objective (str) – (optional) objective of the incident
incident_type (str) – (optional) type of incident
severity (str) – (optional) severity level
source (str) – (optional) source of the incident
x_opencti_stix_ids (list) – (optional) list of additional STIX IDs
objectOrganization (list) – (optional) list of organization IDs
x_opencti_workflow_id (str) – (optional) workflow ID
x_opencti_modified_at (str) – (optional) custom modification date
update (bool) – (optional) whether to update if exists (default: False)
files (list) – (optional) list of File objects to attach
filesMarkings (list) – (optional) list of lists of marking definition IDs for each file
- Returns:
Incident object
- Return type:
dict or None
- static generate_id(name, created)[source]
Generate a STIX ID for an Incident.
- Parameters:
name (str) – The name of the incident
created (str or datetime.datetime) – The creation date of the incident
- Returns:
STIX ID for the incident
- Return type:
str
- static generate_id_from_data(data)[source]
Generate a STIX ID from incident data.
- Parameters:
data (dict) – Dictionary containing ‘name’ and ‘created’ keys
- Returns:
STIX ID for the incident
- Return type:
str
- import_from_stix2(**kwargs)[source]
Import an Incident object from a STIX2 object.
- Parameters:
stixObject (dict) – the STIX2 Incident object
extras (dict) – extra parameters including created_by_id, object_marking_ids, etc.
update (bool) – whether to update if the entity already exists
- Returns:
Incident object
- Return type:
dict or None
- list(**kwargs)[source]
List Incident objects.
- Parameters:
filters (dict) – the filters to apply
search (str) – the search keyword
first (int) – return the first n rows from the after ID (or the beginning if not set)
after (str) – ID of the first row for pagination
orderBy (str) – field to order results by
orderMode (str) – ordering mode (asc/desc)
customAttributes (str) – custom attributes to return
getAll (bool) – whether to retrieve all results
withPagination (bool) – whether to include pagination info
withFiles (bool) – whether to include files
- Returns:
List of Incident objects
- Return type:
list