splunk-soar-sdk 1.3.4__py3-none-any.whl → 1.4.0__py3-none-any.whl

soar_sdk/abstract.py

@@ -63,6 +63,11 @@ class SOARClient(Generic[SummaryType]):
         """Object governing interaction with the SOAR container API. Subclasses must define."""
         pass
 
+    @abstractmethod
+    def get_executing_container_id(self) -> int:
+        """Return the current Container ID passed in the Connector Run Action JSON."""
+        pass
+
     def get(
         self,
         endpoint: str,
@@ -202,7 +207,9 @@ class SOARClient(Generic[SummaryType]):
         return "https://localhost:9999/"
 
     @abstractmethod
-    def update_client(self, soar_auth: SOARClientAuth, asset_id: str) -> None:
+    def update_client(
+        self, soar_auth: SOARClientAuth, asset_id: str, container_id: int = 0
+    ) -> None:
         """Hook to update the SOAR API client before any actions run with the input data.
 
         An example of what this function might do is authenticate the API client.

soar_sdk/app.py

@@ -187,7 +187,9 @@ class App:
 
         self.__logger.handler.set_handle(handle)
         soar_auth = App.create_soar_client_auth_object(input_data)
-        self.soar_client.update_client(soar_auth, input_data.asset_id)
+        self.soar_client.update_client(
+            soar_auth, input_data.asset_id, input_data.container_id
+        )
         return self.actions_manager.handle(input_data, handle=handle)
 
     @staticmethod

soar_sdk/app_client.py

@@ -45,6 +45,7 @@ class AppClient(SOARClient[SummaryType]):
 
         self._summary: Optional[SummaryType] = None
         self._message: Optional[str] = None
+        self.__container_id: int = 0
 
     @property
     def client(self) -> httpx.Client:
@@ -66,10 +67,17 @@ class AppClient(SOARClient[SummaryType]):
         """The SOAR Vault API."""
         return self._vault_api
 
-    def update_client(self, soar_auth: SOARClientAuth, asset_id: str) -> None:
+    def get_executing_container_id(self) -> int:
+        """Return the current Container ID passed in the Connector Run Action JSON."""
+        return self.__container_id
+
+    def update_client(
+        self, soar_auth: SOARClientAuth, asset_id: str, container_id: int = 0
+    ) -> None:
         """Update the SOAR client with the given authentication and asset ID."""
         self.authenticate_soar_client(soar_auth)
         self._containers_api.set_executing_asset(asset_id)
+        self.__container_id = container_id
 
     def authenticate_soar_client(self, soar_auth: SOARClientAuth) -> None:
         """Authenticate the SOAR client with the given authentication credentials."""

{splunk_soar_sdk-1.3.4.dist-info → splunk_soar_sdk-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 1.3.4
+Version: 1.4.0
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-1.3.4.dist-info → splunk_soar_sdk-1.4.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
-soar_sdk/abstract.py,sha256=2PHRzvQSTOx5jjfshwV9XBK96UD7FAzY9lAE8K7wkyU,7656
+soar_sdk/abstract.py,sha256=2fYEc_xdhz635RnUn5Fn7odTuNkzqQ_YjKF25A-KjNM,7863
 soar_sdk/action_results.py,sha256=gAQwHjXbkkzOJTmQnLwBjKjwbuz8mSPyqIVcirVS598,10114
 soar_sdk/actions_manager.py,sha256=vYglKejmPX1MldTzafCVE2K60UiSLhNGfYcVOxD4YwU,5884
-soar_sdk/app.py,sha256=E0XMDEa0ol_Dayxbyo6ITw_YJflCswnW_Gk0n6tyGnM,29160
+soar_sdk/app.py,sha256=lCCOLKfpUxE9WgLYn_S83riHe4vL2Kzcgda2ra4xNs4,29207
 soar_sdk/app_cli_runner.py,sha256=uk9V-cbAHx1tzK_1gCYpfdF7IJ_ZwuWV2Ak4NMOvKGA,11873
-soar_sdk/app_client.py,sha256=Oh8OqU6lbD6CdR47A4maZJKlzXlfwpzPmw3N0gXtqOs,5762
+soar_sdk/app_client.py,sha256=UVCMFYweaYcFk7WrtoVsCoprYZ7JlzMBR108ZQRV8SE,6051
 soar_sdk/asset.py,sha256=_PZnbroenzfyGup7wcFsyJG_2TFcy19hf0Gi1gkBdsQ,10611
 soar_sdk/async_utils.py,sha256=gND8ZiVTqDYLQ88Ua6SN1mInJaEcfa168eOaRoURt3E,1441
 soar_sdk/colors.py,sha256=--i_iXqfyITUz4O95HMjfZQGbwFZ34bLmBhtfpXXqlQ,1095
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-1.3.4.dist-info/METADATA,sha256=kfGr_Urdi1ATwcPSb5z5ZyAtYpkKzCp-kXWXaokO21g,7355
-splunk_soar_sdk-1.3.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-1.3.4.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-1.3.4.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-1.3.4.dist-info/RECORD,,
+splunk_soar_sdk-1.4.0.dist-info/METADATA,sha256=eEoL_4B-eXIvwDIamcQukIMzBWwVl6utKHZkfhDtrYE,7355
+splunk_soar_sdk-1.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-1.4.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-1.4.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-1.4.0.dist-info/RECORD,,