=========
``pycti``
=========

.. automodule:: pycti

   .. contents::
      :local:

.. currentmodule:: pycti


Functions
=========

- :py:func:`get_config_variable`:
  [summary]


.. autofunction:: get_config_variable


Classes
=======

- :py:class:`AttackPattern`:
  Main AttackPattern class for OpenCTI

- :py:class:`Campaign`:
  Main Campaign class for OpenCTI

- :py:class:`CaseIncident`:
  Main CaseIncident class for OpenCTI

- :py:class:`CaseRfi`:
  Main CaseRfi class for OpenCTI

- :py:class:`CaseRft`:
  Main CaseRft class for OpenCTI

- :py:class:`Channel`:
  Main Channel class for OpenCTI

- :py:class:`Task`:
  Main Task class for OpenCTI

- :py:class:`ConnectorType`:
  An enumeration.

- :py:class:`CourseOfAction`:
  Main CourseOfAction class for OpenCTI

- :py:class:`DataComponent`:
  Main DataComponent class for OpenCTI

- :py:class:`DataSource`:
  Main DataSource class for OpenCTI

- :py:class:`ExternalReference`:
  Main ExternalReference class for OpenCTI

- :py:class:`Feedback`:
  Main Feedback class for OpenCTI

- :py:class:`Grouping`:
  Main Grouping class for OpenCTI

- :py:class:`Identity`:
  Main Identity class for OpenCTI

- :py:class:`Incident`:
  Main Incident class for OpenCTI

- :py:class:`Indicator`:
  Main Indicator class for OpenCTI

- :py:class:`Infrastructure`:
  Main Infrastructure class for OpenCTI

- :py:class:`IntrusionSet`:
  Main IntrusionSet class for OpenCTI

- :py:class:`KillChainPhase`:
  Main KillChainPhase class for OpenCTI

- :py:class:`Label`:
  Main Label class for OpenCTI

- :py:class:`Location`:
  Main Location class for OpenCTI

- :py:class:`Malware`:
  Main Malware class for OpenCTI

- :py:class:`MalwareAnalysis`:
  Main MalwareAnalysis class for OpenCTI

- :py:class:`MarkingDefinition`:
  Main MarkingDefinition class for OpenCTI

- :py:class:`Note`:
  Main Note class for OpenCTI

- :py:class:`ObservedData`:
  Main ObservedData class for OpenCTI

- :py:class:`OpenCTIApiClient`:
  Main API client for OpenCTI

- :py:class:`OpenCTIApiConnector`:
  OpenCTI API Connector client

- :py:class:`OpenCTIApiWork`:
  OpenCTI API Work client

- :py:class:`OpenCTIConnector`:
  Main class for OpenCTI connector

- :py:class:`OpenCTIConnectorHelper`:
  Python API for OpenCTI connector

- :py:class:`OpenCTIMetricHandler`:
  Main OpenCTI Metric Handler class

- :py:class:`OpenCTIStix2`:
  Python API for Stix2 in OpenCTI

- :py:class:`OpenCTIStix2Splitter`:
  Main OpenCTI Stix2 Splitter class

- :py:class:`OpenCTIStix2Update`:
  Python API for Stix2 Update in OpenCTI

- :py:class:`OpenCTIStix2Utils`:
  Main OpenCTI Stix2 Utils class

- :py:class:`Opinion`:
  Main Opinion class for OpenCTI

- :py:class:`Report`:
  Main Report class for OpenCTI

- :py:class:`StixCoreRelationship`:
  Main StixCoreRelationship class for OpenCTI

- :py:class:`StixCyberObservable`:
  Deprecated StixCyberObservable class [>=6.2 & <6.5]

- :py:class:`StixNestedRefRelationship`:
  Main StixNestedRefRelationship class for OpenCTI

- :py:class:`StixCyberObservableTypes`:
  An enumeration.

- :py:class:`StixDomainObject`:
  Main StixDomainObject class for OpenCTI

- :py:class:`StixMetaTypes`:
  An enumeration.

- :py:class:`MultipleRefRelationship`:
  An enumeration.

- :py:class:`StixObjectOrStixRelationship`:
  Main StixObjectOrStixRelationship class for OpenCTI

- :py:class:`StixSightingRelationship`:
  Main StixSightingRelationship class for OpenCTI

- :py:class:`ThreatActor`:
  Main ThreatActor class for OpenCTI

- :py:class:`ThreatActorGroup`:
  Main ThreatActorGroup class for OpenCTI

- :py:class:`ThreatActorIndividual`:
  Main ThreatActorIndividual class for OpenCTI

- :py:class:`Tool`:
  Main Tool class for OpenCTI

- :py:class:`Vulnerability`:
  Main Vulnerability class for OpenCTI

- :py:class:`CustomObjectCaseIncident`:
  Case-Incident object.

- :py:class:`CustomObjectTask`:
  Task object.

- :py:class:`CustomObjectChannel`:
  Channel object.

- :py:class:`CustomObservableCredential`:
  Credential observable.

- :py:class:`CustomObservableHostname`:
  Hostname observable.

- :py:class:`CustomObservableUserAgent`:
  User-Agent observable.

- :py:class:`CustomObservableBankAccount`:
  Bank Account observable.

- :py:class:`CustomObservableCryptocurrencyWallet`:
  Cryptocurrency wallet observable.

- :py:class:`CustomObservablePaymentCard`:
  Payment card observable.

- :py:class:`CustomObservablePhoneNumber`:
  Phone number observable.

- :py:class:`CustomObservableTrackingNumber`:
  Tracking number observable.

- :py:class:`CustomObservableText`:
  Text observable.

- :py:class:`CustomObservableMediaContent`:
  Media-Content observable.

- :py:class:`Capability`:
  Represents a role capability on the OpenCTI platform

- :py:class:`Role`:
  Representation of a role in OpenCTI

- :py:class:`Group`:
  Representation of a Group in OpenCTI

- :py:class:`User`:
  Representation of a user on the OpenCTI platform

- :py:class:`Settings`:
  Represents the Settings object in OpenCTI


.. autoclass:: AttackPattern
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: AttackPattern
      :parts: 1

.. autoclass:: Campaign
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Campaign
      :parts: 1

.. autoclass:: CaseIncident
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CaseIncident
      :parts: 1

.. autoclass:: CaseRfi
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CaseRfi
      :parts: 1

.. autoclass:: CaseRft
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CaseRft
      :parts: 1

.. autoclass:: Channel
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Channel
      :parts: 1

.. autoclass:: Task
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Task
      :parts: 1

.. autoclass:: ConnectorType
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ConnectorType
      :parts: 1

.. autoclass:: CourseOfAction
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CourseOfAction
      :parts: 1

.. autoclass:: DataComponent
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: DataComponent
      :parts: 1

.. autoclass:: DataSource
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: DataSource
      :parts: 1

.. autoclass:: ExternalReference
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ExternalReference
      :parts: 1

.. autoclass:: Feedback
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Feedback
      :parts: 1

.. autoclass:: Grouping
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Grouping
      :parts: 1

.. autoclass:: Identity
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Identity
      :parts: 1

.. autoclass:: Incident
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Incident
      :parts: 1

.. autoclass:: Indicator
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Indicator
      :parts: 1

.. autoclass:: Infrastructure
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Infrastructure
      :parts: 1

.. autoclass:: IntrusionSet
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: IntrusionSet
      :parts: 1

.. autoclass:: KillChainPhase
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: KillChainPhase
      :parts: 1

.. autoclass:: Label
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Label
      :parts: 1

.. autoclass:: Location
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Location
      :parts: 1

.. autoclass:: Malware
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Malware
      :parts: 1

.. autoclass:: MalwareAnalysis
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MalwareAnalysis
      :parts: 1

.. autoclass:: MarkingDefinition
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MarkingDefinition
      :parts: 1

.. autoclass:: Note
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Note
      :parts: 1

.. autoclass:: ObservedData
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ObservedData
      :parts: 1

.. autoclass:: OpenCTIApiClient
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIApiClient
      :parts: 1

.. autoclass:: OpenCTIApiConnector
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIApiConnector
      :parts: 1

.. autoclass:: OpenCTIApiWork
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIApiWork
      :parts: 1

.. autoclass:: OpenCTIConnector
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIConnector
      :parts: 1

.. autoclass:: OpenCTIConnectorHelper
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIConnectorHelper
      :parts: 1

.. autoclass:: OpenCTIMetricHandler
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIMetricHandler
      :parts: 1

.. autoclass:: OpenCTIStix2
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2
      :parts: 1

.. autoclass:: OpenCTIStix2Splitter
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2Splitter
      :parts: 1

.. autoclass:: OpenCTIStix2Update
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2Update
      :parts: 1

.. autoclass:: OpenCTIStix2Utils
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2Utils
      :parts: 1

.. autoclass:: Opinion
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Opinion
      :parts: 1

.. autoclass:: Report
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Report
      :parts: 1

.. autoclass:: StixCoreRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixCoreRelationship
      :parts: 1

.. autoclass:: StixCyberObservable
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixCyberObservable
      :parts: 1

.. autoclass:: StixNestedRefRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixNestedRefRelationship
      :parts: 1

.. autoclass:: StixCyberObservableTypes
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixCyberObservableTypes
      :parts: 1

.. autoclass:: StixDomainObject
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixDomainObject
      :parts: 1

.. autoclass:: StixMetaTypes
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixMetaTypes
      :parts: 1

.. autoclass:: MultipleRefRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MultipleRefRelationship
      :parts: 1

.. autoclass:: StixObjectOrStixRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixObjectOrStixRelationship
      :parts: 1

.. autoclass:: StixSightingRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixSightingRelationship
      :parts: 1

.. autoclass:: ThreatActor
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ThreatActor
      :parts: 1

.. autoclass:: ThreatActorGroup
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ThreatActorGroup
      :parts: 1

.. autoclass:: ThreatActorIndividual
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ThreatActorIndividual
      :parts: 1

.. autoclass:: Tool
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Tool
      :parts: 1

.. autoclass:: Vulnerability
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Vulnerability
      :parts: 1

.. autoclass:: CustomObjectCaseIncident
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObjectCaseIncident
      :parts: 1

.. autoclass:: CustomObjectTask
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObjectTask
      :parts: 1

.. autoclass:: CustomObjectChannel
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObjectChannel
      :parts: 1

.. autoclass:: CustomObservableCredential
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableCredential
      :parts: 1

.. autoclass:: CustomObservableHostname
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableHostname
      :parts: 1

.. autoclass:: CustomObservableUserAgent
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableUserAgent
      :parts: 1

.. autoclass:: CustomObservableBankAccount
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableBankAccount
      :parts: 1

.. autoclass:: CustomObservableCryptocurrencyWallet
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableCryptocurrencyWallet
      :parts: 1

.. autoclass:: CustomObservablePaymentCard
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservablePaymentCard
      :parts: 1

.. autoclass:: CustomObservablePhoneNumber
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservablePhoneNumber
      :parts: 1

.. autoclass:: CustomObservableTrackingNumber
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableTrackingNumber
      :parts: 1

.. autoclass:: CustomObservableText
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableText
      :parts: 1

.. autoclass:: CustomObservableMediaContent
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableMediaContent
      :parts: 1

.. autoclass:: Capability
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Capability
      :parts: 1

.. autoclass:: Role
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Role
      :parts: 1

.. autoclass:: Group
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Group
      :parts: 1

.. autoclass:: User
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: User
      :parts: 1

.. autoclass:: Settings
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Settings
      :parts: 1


Variables
=========

- :py:data:`STIX_EXT_MITRE`
- :py:data:`STIX_EXT_OCTI_SCO`
- :py:data:`STIX_EXT_OCTI`

.. autodata:: STIX_EXT_MITRE
   :annotation:

   .. code-block:: text

      'extension-definition--322b8f77-262a-4cb8-a915-1e441e00329b'

.. autodata:: STIX_EXT_OCTI_SCO
   :annotation:

   .. code-block:: text

      'extension-definition--f93e2c80-4231-4f9a-af8b-95c9bd566a82'

.. autodata:: STIX_EXT_OCTI
   :annotation:

   .. code-block:: text

      'extension-definition--ea279b3e-5c71-4632-ac08-831c66a786ba'