pycti.entities.opencti_security_coverage ======================================== .. py:module:: pycti.entities.opencti_security_coverage Classes ------- .. autoapisummary:: pycti.entities.opencti_security_coverage.SecurityCoverage Module Contents --------------- .. py:class:: SecurityCoverage(opencti) Main SecurityCoverage class for OpenCTI Manages security coverage entities in the OpenCTI platform. :param opencti: instance of :py:class:`~pycti.api.opencti_api_client.OpenCTIApiClient` :type opencti: OpenCTIApiClient Initialize the SecurityCoverage instance. :param opencti: OpenCTI API client instance :type opencti: OpenCTIApiClient .. py:attribute:: opencti .. py:attribute:: properties :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ id standard_id entity_type parent_types spec_version created_at updated_at external_uri objectCovered { __typename ... on StixCoreObject { id } } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } """ .. raw:: html
.. py:method:: generate_id(covered_ref) :staticmethod: Generate a STIX ID for a Security Coverage. :param covered_ref: The reference to the covered object :type covered_ref: str :return: STIX ID for the security coverage :rtype: str .. py:method:: generate_id_from_data(data) :staticmethod: Generate a STIX ID from security coverage data. :param data: Dictionary containing 'covered_ref' key :type data: dict :return: STIX ID for the security coverage :rtype: str .. py:method:: list(**kwargs) List SecurityCoverage objects. :param filters: the filters to apply :param search: the search keyword :param first: return the first n rows from the after ID (or the beginning if not set) :param after: ID of the first row for pagination :return: List of SecurityCoverage objects :rtype: list .. py:method:: read(**kwargs) Read a SecurityCoverage object. :param id: the id of the SecurityCoverage :type id: str :param filters: the filters to apply if no id provided :type filters: dict :param customAttributes: custom attributes to return :type customAttributes: str :return: SecurityCoverage object :rtype: dict or None .. py:method:: create(**kwargs) Create a Security coverage object. :param name: the name of the Security Coverage (required) :type name: str :param objectCovered: the covered object ID (required) :type objectCovered: str :param stix_id: (optional) the STIX ID :type stix_id: str :param description: (optional) description :type description: str :param createdBy: (optional) the author ID :type createdBy: str :param objectMarking: (optional) list of marking definition IDs :type objectMarking: list :param objectLabel: (optional) list of label IDs :type objectLabel: list :param externalReferences: (optional) list of external reference IDs :type externalReferences: list :param external_uri: (optional) external URI :type external_uri: str :param coverage_last_result: (optional) last result date :type coverage_last_result: str :param coverage_valid_from: (optional) valid from date :type coverage_valid_from: str :param coverage_valid_to: (optional) valid to date :type coverage_valid_to: str :param coverage_information: (optional) coverage information :type coverage_information: list :param auto_enrichment_disable: (optional) disable auto enrichment :type auto_enrichment_disable: bool :param periodicity: (optional) periodicity :type periodicity: str :param duration: (optional) duration :type duration: str :param type_affinity: (optional) type affinity :type type_affinity: str :param platforms_affinity: (optional) platforms affinity :type platforms_affinity: list :param files: (optional) list of File objects to attach :type files: list :param filesMarkings: (optional) list of lists of marking definition IDs for each file :type filesMarkings: list :return: Security Coverage object :rtype: dict or None .. py:method:: import_from_stix2(**kwargs) Import a Security coverage from a STIX2 object. :param stixObject: the STIX2 Security coverage object :type stixObject: dict :param extras: extra parameters including created_by_id, object_marking_ids, etc. :type extras: dict :param update: whether to update if the entity already exists :type update: bool :return: Security coverage object :rtype: dict or None