pycti.entities.opencti_kill_chain_phase
=======================================

.. py:module:: pycti.entities.opencti_kill_chain_phase


Classes
-------

.. autoapisummary::

   pycti.entities.opencti_kill_chain_phase.KillChainPhase


Module Contents
---------------

.. py:class:: KillChainPhase(opencti)

   Main KillChainPhase class for OpenCTI

   Manages kill chain phases (ATT&CK tactics) in the OpenCTI platform.

   :param opencti: instance of :py:class:`~pycti.api.opencti_api_client.OpenCTIApiClient`
   :type opencti: OpenCTIApiClient

   Initialize the KillChainPhase instance.

   :param opencti: OpenCTI API client instance
   :type opencti: OpenCTIApiClient


   .. py:attribute:: opencti


   .. py:attribute:: properties
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                     id
                     standard_id
                     entity_type
                     parent_types
                     kill_chain_name
                     phase_name
                     x_opencti_order
                     created
                     modified
                     created_at
                     updated_at
                 """

      .. raw:: html

         </details>




   .. py:method:: generate_id(phase_name, kill_chain_name)
      :staticmethod:


      Generate a STIX ID for a Kill Chain Phase.

      :param phase_name: The phase name
      :type phase_name: str
      :param kill_chain_name: The kill chain name
      :type kill_chain_name: str
      :return: STIX ID for the kill chain phase
      :rtype: str



   .. py:method:: generate_id_from_data(data)
      :staticmethod:


      Generate a STIX ID from kill chain phase data.

      :param data: Dictionary containing 'phase_name' and 'kill_chain_name' keys
      :type data: dict
      :return: STIX ID for the kill chain phase
      :rtype: str



   .. py:method:: list(**kwargs)

      List Kill-Chain-Phase objects.

      :param filters: the filters to apply
      :type filters: dict
      :param first: return the first n rows from the after ID (or the beginning if not set)
      :type first: int
      :param after: ID of the first row for pagination
      :type after: str
      :param orderBy: field to order results by
      :type orderBy: str
      :param orderMode: ordering mode (asc/desc)
      :type orderMode: str
      :param customAttributes: custom attributes to return
      :type customAttributes: list
      :param withPagination: whether to include pagination info
      :type withPagination: bool
      :return: List of Kill-Chain-Phase objects
      :rtype: list



   .. py:method:: read(**kwargs)

      Read a Kill-Chain-Phase object.

      :param id: the id of the Kill-Chain-Phase
      :type id: str
      :param filters: the filters to apply if no id provided
      :type filters: dict
      :return: Kill-Chain-Phase object
      :rtype: dict or None



   .. py:method:: create(**kwargs)

      Create a Kill-Chain-Phase object.

      :param stix_id: (optional) the STIX ID
      :type stix_id: str
      :param created: (optional) creation date
      :type created: datetime
      :param modified: (optional) modification date
      :type modified: datetime
      :param kill_chain_name: the kill chain name (required)
      :type kill_chain_name: str
      :param phase_name: the phase name (required)
      :type phase_name: str
      :param x_opencti_order: (optional) order (default: 0)
      :type x_opencti_order: int
      :param update: (optional) whether to update if exists (default: False)
      :type update: bool
      :return: Kill-Chain-Phase object
      :rtype: dict or None



   .. py:method:: update_field(**kwargs)

      Update a Kill Chain Phase object field.

      :param id: the Kill Chain Phase id
      :type id: str
      :param input: the input of the field
      :type input: list
      :return: The updated Kill Chain Phase object
      :rtype: dict or None



   .. py:method:: delete(**kwargs)

      Delete a Kill-Chain-Phase object.

      :param id: the id of the Kill-Chain-Phase to delete
      :type id: str
      :return: None