pycti.entities.opencti_campaign
Classes
Main Campaign class for OpenCTI |
Module Contents
- class pycti.entities.opencti_campaign.Campaign(opencti)[source]
Main Campaign class for OpenCTI
Manages threat campaigns in the OpenCTI platform.
- Parameters:
opencti (OpenCTIApiClient) – instance of
OpenCTIApiClient
Initialize the Campaign instance.
- Parameters:
opencti (OpenCTIApiClient) – OpenCTI API client instance
- properties = Multiline-String[source]
Show Value
""" id standard_id entity_type parent_types spec_version created_at updated_at status { id template { id name color } } createdBy { ... on Identity { id standard_id entity_type parent_types spec_version identity_class name description roles contact_information x_opencti_aliases created modified objectLabel { id value color } } ... on Organization { x_opencti_organization_type x_opencti_reliability } ... on Individual { x_opencti_firstname x_opencti_lastname } } objectOrganization { id standard_id name } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } objectLabel { id value color } externalReferences { edges { node { id standard_id entity_type source_name description url hash external_id created modified } } } revoked confidence created modified name description aliases first_seen last_seen objective """
- properties_with_files = Multiline-String[source]
Show Value
""" id standard_id entity_type parent_types spec_version created_at updated_at status { id template { id name color } } createdBy { ... on Identity { id standard_id entity_type parent_types spec_version identity_class name description roles contact_information x_opencti_aliases created modified objectLabel { id value color } } ... on Organization { x_opencti_organization_type x_opencti_reliability } ... on Individual { x_opencti_firstname x_opencti_lastname } } objectOrganization { id standard_id name } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } objectLabel { id value color } externalReferences { edges { node { id standard_id entity_type source_name description url hash external_id created modified importFiles { edges { node { id name size metaData { mimetype version } } } } } } } revoked confidence created modified name description aliases first_seen last_seen objective importFiles { edges { node { id name size metaData { mimetype version } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } } } } """
- static generate_id(name)[source]
Generate a STIX ID for a Campaign.
- Parameters:
name (str) – The name of the campaign
- Returns:
STIX ID for the campaign
- Return type:
str
- static generate_id_from_data(data)[source]
Generate a STIX ID from campaign data.
- Parameters:
data (dict) – Dictionary containing ‘name’ key
- Returns:
STIX ID for the campaign
- Return type:
str
- list(**kwargs)[source]
List Campaign 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 Campaign objects
- Return type:
list
- read(**kwargs)[source]
Read a Campaign object.
- Parameters:
id (str) – the id of the Campaign
filters (dict) – the filters to apply if no id provided
customAttributes (str) – custom attributes to return
withFiles (bool) – whether to include files
- Returns:
Campaign object
- Return type:
dict or None
- create(**kwargs)[source]
Create a Campaign object.
- Parameters:
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 campaign is revoked
confidence (int) – (optional) confidence level (0-100)
lang (str) – (optional) language
created (str) – (optional) creation date
modified (str) – (optional) modification date
name (str) – the name of the Campaign (required)
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 campaign
objectOrganization (list) – (optional) list of organization IDs
x_opencti_stix_ids (list) – (optional) list of additional STIX 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:
Campaign object
- Return type:
dict or None
- import_from_stix2(**kwargs)[source]
Import a Campaign object from a STIX2 object.
- Parameters:
stixObject (dict) – the STIX2 Campaign object
extras (dict) – extra parameters including created_by_id, object_marking_ids, etc.
update (bool) – whether to update if the entity already exists
- Returns:
Campaign object
- Return type:
dict or None