Update docstrings to reflect changes from #647.

CrowdStrike · May 9, 2022 · 4659cac · 4659cac
1 parent b011511
commit 4659cac
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 5 deletions.
diff --git a/src/falconpy/device_control_policies.py b/src/falconpy/device_control_policies.py
@@ -145,14 +145,16 @@ def perform_action(self: object, body: dict = None, parameters: dict = None, **k
                 {
                     "action_parameters": [
                         {
-                            "name": "string",
+                            "name": "group_id",
                             "value": "string"
                         }
                     ],
                     "ids": [
                         "string"
                     ]
                 }
+        group_id -- Host Group ID to apply the policy to. String.
+                    Overridden if action_parameters is specified.
         ids -- Device Control policy ID(s) to perform actions against. String or list of strings.
         parameters - full parameters payload, not required if action_name is provided as a keyword.
 

diff --git a/src/falconpy/host_group.py b/src/falconpy/host_group.py
@@ -150,14 +150,16 @@ def perform_group_action(self: object,
                 {
                     "action_parameters": [
                         {
-                            "name": "string",
+                            "name": "filter",
                             "value": "string"
                         }
                     ],
                     "ids": [
                         "string"
                     ]
                 }
+        filter -- Filter to use to specify hosts to apply this action to. FQL formatted string.
+                  Overridden if action_parameters is specified.
         ids -- List of host group IDs to perform an action against. String or list of strings.
 
         This method only supports keywords for providing arguments.

diff --git a/src/falconpy/incidents.py b/src/falconpy/incidents.py
@@ -124,6 +124,28 @@ def perform_incident_action(self: object, body: dict = None, **kwargs) -> dict:
 
         Keyword arguments:
         action_parameters -- Action specific parameters. List of dictionaries.
+        add_tag -- Adds the associated value as a new tag on all the incidents of the ids list.
+                   Overridden if action_parameters is specified. String.
+        delete_tag -- Deletes tags matching the value from all the incidents in the ids list.
+                      Overridden if action_parameters is specified. String.
+        unassign -- Unassigns all users from all of the incidents in the ids list.
+                    Overridden if action_parameters is specified. Boolean.
+        update_name -- Updates the name to the parameter value of all the incidents
+                       in the ids list. Overridden if action_parameters is specified. String.
+        update_assigned_to_v2 -- Assigns the user matching the UUID in the parameter
+                                 value to all of the incidents in the ids list. For information
+                                 on getting the UUID of a user, see Find existing users.
+                                 Overridden if action_parameters is specified. UUID string.
+        update_description -- Updates the description to the parameter value of all the
+                              incidents listed in the ids list.
+                              Overridden if action_parameters is specified. String.
+        update_status -- Updates the status to the parameter value of all the incidents
+                         in the ids list. Valid status values are 20, 25, 30, or 40:
+                            20: New
+                            25: Reopened
+                            30: In Progress
+                            40: Closed
+                         Overridden if action_parameters is specified. Integer string.
         body -- full body payload, not required if ids is provided as keyword.
                 {
                     "action_parameters": [

diff --git a/src/falconpy/prevention_policy.py b/src/falconpy/prevention_policy.py
@@ -145,14 +145,16 @@ def perform_policies_action(self: object,
                 {
                     "action_parameters": [
                         {
-                            "name": "string",
+                            "name": "group_id",
                             "value": "string"
                         }
                     ],
                     "ids": [
                         "string"
                     ]
                 }
+        group_id -- Host Group ID to apply the policy to. String.
+                    Overridden if action_parameters is provided.
         ids -- Prevention policy ID(s) to perform actions against. String or list of strings.
         parameters - full parameters payload, not required if action_name is provide as a keyword.
 

diff --git a/src/falconpy/response_policies.py b/src/falconpy/response_policies.py
@@ -139,14 +139,16 @@ def perform_policies_action(self: object,
                 {
                     "action_parameters": [
                         {
-                            "name": "string",
+                            "name": "group_id",
                             "value": "string"
                         }
                     ],
                     "ids": [
                         "string"
                     ]
                 }
+        group_id -- Host Group ID to apply the policy to. String.
+                    Overridden if action_parameters is provided.
         ids -- Response policy ID(s) to perform actions against. String or list of strings.
         parameters - full parameters payload, not required if action_name is provide as a keyword.
 

diff --git a/src/falconpy/sensor_update_policy.py b/src/falconpy/sensor_update_policy.py
@@ -280,14 +280,16 @@ def perform_policies_action(self: object,
                 {
                     "action_parameters": [
                         {
-                            "name": "string",
+                            "name": "group_id",
                             "value": "string"
                         }
                     ],
                     "ids": [
                         "string"
                     ]
                 }
+        group_id -- Host Group ID to apply the policy to. String.
+                    Overridden if action_parameters is specified.
         ids -- Sensor Update policy ID(s) to perform actions against. String or list of strings.
         parameters - full parameters payload, not required if action_name is provided as a keyword.