pycti.entities.opencti_audit
============================

.. py:module:: pycti.entities.opencti_audit


Classes
-------

.. autoapisummary::

   pycti.entities.opencti_audit.Audit


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

.. py:class:: Audit(opencti)

   Main Audit class for OpenCTI

   Reads audits in the OpenCTI platform.

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

   Initialize the Audit 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
                     entity_type
                     event_type
                     event_scope
                     event_status
                     timestamp
                     user_id
                     context_uri
                     user_metadata
                 """

      .. raw:: html

         </details>




   .. py:method:: list(**kwargs) -> List[Dict]

      List Audit objects.

      :param filters: the filters to apply
      :type filters: dict
      :param search: the search keyword
      :type search: str
      :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: str
      :param getAll: whether to retrieve all results
      :type getAll: bool
      :param withPagination: whether to include pagination info
      :type withPagination: bool
      :return: List of Task objects
      :rtype: list



   .. py:method:: read(**kwargs) -> Optional[Dict]

      Reads audit details from the platform.

      :param id: ID of the audit to fetch
      :type id: str, optional
      :param customAttributes: Custom attributes to include instead of the
          defaults
      :type customAttribues: str, optional
      :param filters: Filters to apply to find a single user
      :type filters: dict, optional
      :param search: Search term to use to find a single user
      :type search: str, optional
      :return: Representation of the audit as a Python dictionary.
      :rtype: Optional[Dict]