[client] Add administrative entities and functionality (#827)

peritz · peritz · web-flow · commit a9a0ed1f4713 · 2025-02-11T12:20:42.000+01:00
Co-authored-by: peritz &lt;peritz@pardonmynoot.com&gt;
diff --git a/docs/pycti/pycti.api.opencti_api_client.rst b/docs/pycti/pycti.api.opencti_api_client.rst
@@ -3,6 +3,7 @@
 ================================
 
 .. automodule:: pycti.api.opencti_api_client
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.api.opencti_api_connector.rst b/docs/pycti/pycti.api.opencti_api_connector.rst
@@ -3,6 +3,7 @@
 ===================================
 
 .. automodule:: pycti.api.opencti_api_connector
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.api.opencti_api_job.rst b/docs/pycti/pycti.api.opencti_api_job.rst
@@ -3,6 +3,7 @@
 =============================
 
 .. automodule:: pycti.api.opencti_api_job
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.api.rst b/docs/pycti/pycti.api.rst
@@ -3,6 +3,7 @@
 =============
 
 .. automodule:: pycti.api
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.connector.opencti_connector.rst b/docs/pycti/pycti.connector.opencti_connector.rst
@@ -3,6 +3,7 @@
 =====================================
 
 .. automodule:: pycti.connector.opencti_connector
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.connector.opencti_connector_helper.rst b/docs/pycti/pycti.connector.opencti_connector_helper.rst
@@ -3,6 +3,7 @@
 ============================================
 
 .. automodule:: pycti.connector.opencti_connector_helper
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.connector.rst b/docs/pycti/pycti.connector.rst
@@ -3,6 +3,7 @@
 ===================
 
 .. automodule:: pycti.connector
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_attack_pattern.rst b/docs/pycti/pycti.entities.opencti_attack_pattern.rst
@@ -3,6 +3,7 @@
 =========================================
 
 .. automodule:: pycti.entities.opencti_attack_pattern
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_campaign.rst b/docs/pycti/pycti.entities.opencti_campaign.rst
@@ -3,6 +3,7 @@
 ===================================
 
 .. automodule:: pycti.entities.opencti_campaign
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_capability.rst b/docs/pycti/pycti.entities.opencti_capability.rst
@@ -0,0 +1,11 @@
+====================================
+``pycti.entities.opencti_capability``
+====================================
+
+.. automodule:: pycti.entities.opencti_capability
+   :members:
+
+   .. contents::
+      :local:
+
+.. currentmodule:: pycti.entities.opencti_capability
diff --git a/docs/pycti/pycti.entities.opencti_course_of_action.rst b/docs/pycti/pycti.entities.opencti_course_of_action.rst
@@ -3,6 +3,7 @@
 ===========================================
 
 .. automodule:: pycti.entities.opencti_course_of_action
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_external_reference.rst b/docs/pycti/pycti.entities.opencti_external_reference.rst
@@ -3,6 +3,7 @@
 =============================================
 
 .. automodule:: pycti.entities.opencti_external_reference
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_group.rst b/docs/pycti/pycti.entities.opencti_group.rst
@@ -0,0 +1,11 @@
+====================================
+``pycti.entities.opencti_group``
+====================================
+
+.. automodule:: pycti.entities.opencti_group
+   :members:
+
+   .. contents::
+      :local:
+
+.. currentmodule:: pycti.entities.opencti_group
diff --git a/docs/pycti/pycti.entities.opencti_identity.rst b/docs/pycti/pycti.entities.opencti_identity.rst
@@ -3,6 +3,7 @@
 ===================================
 
 .. automodule:: pycti.entities.opencti_identity
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_incident.rst b/docs/pycti/pycti.entities.opencti_incident.rst
@@ -3,6 +3,7 @@
 ===================================
 
 .. automodule:: pycti.entities.opencti_incident
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_indicator.rst b/docs/pycti/pycti.entities.opencti_indicator.rst
@@ -3,6 +3,7 @@
 ====================================
 
 .. automodule:: pycti.entities.opencti_indicator
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_intrusion_set.rst b/docs/pycti/pycti.entities.opencti_intrusion_set.rst
@@ -3,6 +3,7 @@
 ========================================
 
 .. automodule:: pycti.entities.opencti_intrusion_set
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_kill_chain_phase.rst b/docs/pycti/pycti.entities.opencti_kill_chain_phase.rst
@@ -3,6 +3,7 @@
 ===========================================
 
 .. automodule:: pycti.entities.opencti_kill_chain_phase
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_malware.rst b/docs/pycti/pycti.entities.opencti_malware.rst
@@ -3,6 +3,7 @@
 ==================================
 
 .. automodule:: pycti.entities.opencti_malware
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_marking_definition.rst b/docs/pycti/pycti.entities.opencti_marking_definition.rst
@@ -3,6 +3,7 @@
 =============================================
 
 .. automodule:: pycti.entities.opencti_marking_definition
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_note.rst b/docs/pycti/pycti.entities.opencti_note.rst
@@ -3,6 +3,7 @@
 ===============================
 
 .. automodule:: pycti.entities.opencti_note
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_opinion.rst b/docs/pycti/pycti.entities.opencti_opinion.rst
@@ -3,6 +3,7 @@
 ==================================
 
 .. automodule:: pycti.entities.opencti_opinion
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_report.rst b/docs/pycti/pycti.entities.opencti_report.rst
@@ -3,6 +3,7 @@
 =================================
 
 .. automodule:: pycti.entities.opencti_report
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_role.rst b/docs/pycti/pycti.entities.opencti_role.rst
@@ -0,0 +1,11 @@
+====================================
+``pycti.entities.opencti_role``
+====================================
+
+.. automodule:: pycti.entities.opencti_role
+   :members:
+
+   .. contents::
+      :local:
+
+.. currentmodule:: pycti.entities.opencti_role
diff --git a/docs/pycti/pycti.entities.opencti_settings.rst b/docs/pycti/pycti.entities.opencti_settings.rst
@@ -0,0 +1,11 @@
+====================================
+``pycti.entities.opencti_settings``
+====================================
+
+.. automodule:: pycti.entities.opencti_settings
+   :members:
+
+   .. contents::
+      :local:
+
+.. currentmodule:: pycti.entities.opencti_settings
diff --git a/docs/pycti/pycti.entities.opencti_stix_domain_entity.rst b/docs/pycti/pycti.entities.opencti_stix_domain_entity.rst
@@ -3,6 +3,7 @@
 =============================================
 
 .. automodule:: pycti.entities.opencti_stix_domain_object
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_stix_entity.rst b/docs/pycti/pycti.entities.opencti_stix_entity.rst
@@ -3,6 +3,7 @@
 ======================================
 
 .. automodule:: pycti.entities.opencti_stix_entity
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_stix_observable.rst b/docs/pycti/pycti.entities.opencti_stix_observable.rst
@@ -3,6 +3,7 @@
 ==========================================
 
 .. automodule:: pycti.entities.opencti_stix_observable
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_stix_observable_relation.rst b/docs/pycti/pycti.entities.opencti_stix_observable_relation.rst
@@ -3,6 +3,7 @@
 ===================================================
 
 .. automodule:: pycti.entities.opencti_stix_observable_relationship
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_stix_relation.rst b/docs/pycti/pycti.entities.opencti_stix_relation.rst
@@ -3,6 +3,7 @@
 ========================================
 
 .. automodule:: pycti.entities.opencti_stix_relation
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_stix_sighting.rst b/docs/pycti/pycti.entities.opencti_stix_sighting.rst
@@ -3,6 +3,7 @@
 ========================================
 
 .. automodule:: pycti.entities.opencti_stix_sighting
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_tag.rst b/docs/pycti/pycti.entities.opencti_tag.rst
@@ -3,6 +3,7 @@
 ==============================
 
 .. automodule:: pycti.entities.opencti_tag
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_threat_actor.rst b/docs/pycti/pycti.entities.opencti_threat_actor.rst
@@ -3,6 +3,7 @@
 =======================================
 
 .. automodule:: pycti.entities.opencti_threat_actor
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_tool.rst b/docs/pycti/pycti.entities.opencti_tool.rst
@@ -3,6 +3,7 @@
 ===============================
 
 .. automodule:: pycti.entities.opencti_tool
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.opencti_user.rst b/docs/pycti/pycti.entities.opencti_user.rst
@@ -0,0 +1,11 @@
+====================================
+``pycti.entities.opencti_user``
+====================================
+
+.. automodule:: pycti.entities.opencti_user
+   :members:
+
+   .. contents::
+      :local:
+
+.. currentmodule:: pycti.entities.opencti_user
diff --git a/docs/pycti/pycti.entities.opencti_vulnerability.rst b/docs/pycti/pycti.entities.opencti_vulnerability.rst
@@ -3,6 +3,7 @@
 ========================================
 
 .. automodule:: pycti.entities.opencti_vulnerability
+   :members:
 
    .. contents::
       :local:
diff --git a/docs/pycti/pycti.entities.rst b/docs/pycti/pycti.entities.rst
@@ -3,6 +3,7 @@
 ==================
 
 .. automodule:: pycti.entities
+   :members:
 
    .. contents::
       :local:
@@ -37,5 +38,10 @@ Submodules
    pycti.entities.opencti_threat_actor
    pycti.entities.opencti_tool
    pycti.entities.opencti_vulnerability
+   pycti.entities.opencti_capability
+   pycti.entities.opencti_role
+   pycti.entities.opencti_group
+   pycti.entities.opencti_user
+   pycti.entities.opencti_settings
 
 .. currentmodule:: pycti.entities
diff --git a/docs/pycti/pycti.rst b/docs/pycti/pycti.rst
diff --git a/docs/pycti/pycti.utils.constants.rst b/docs/pycti/pycti.utils.constants.rst
diff --git a/docs/pycti/pycti.utils.opencti_stix2.rst b/docs/pycti/pycti.utils.opencti_stix2.rst
diff --git a/docs/pycti/pycti.utils.rst b/docs/pycti/pycti.utils.rst
diff --git a/pycti/__init__.py b/pycti/__init__.py
diff --git a/pycti/api/opencti_api_client.py b/pycti/api/opencti_api_client.py
diff --git a/pycti/entities/opencti_capability.py b/pycti/entities/opencti_capability.py
diff --git a/pycti/entities/opencti_group.py b/pycti/entities/opencti_group.py
diff --git a/pycti/entities/opencti_role.py b/pycti/entities/opencti_role.py
diff --git a/pycti/entities/opencti_settings.py b/pycti/entities/opencti_settings.py
diff --git a/pycti/entities/opencti_user.py b/pycti/entities/opencti_user.py
diff --git a/tests/02-integration/entities/test_entity_crud.py b/tests/02-integration/entities/test_entity_crud.py
diff --git a/tests/02-integration/entities/test_group.py b/tests/02-integration/entities/test_group.py
diff --git a/tests/02-integration/entities/test_role.py b/tests/02-integration/entities/test_role.py
diff --git a/tests/02-integration/entities/test_settings.py b/tests/02-integration/entities/test_settings.py
diff --git a/tests/02-integration/entities/test_user.py b/tests/02-integration/entities/test_user.py
diff --git a/tests/cases/entities.py b/tests/cases/entities.py
