Security findings default and regular inbox rules API spec

examples/v2/security-monitoring/CreateSecurityFindingsAutomationInboxRule.py

@@ -0,0 +1,40 @@
+"""
+Create an inbox rule returns "Successfully created the inbox rule" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.automation_rule_scope import AutomationRuleScope
+from datadog_api_client.v2.model.inbox_rule_action import InboxRuleAction
+from datadog_api_client.v2.model.inbox_rule_attributes_create import InboxRuleAttributesCreate
+from datadog_api_client.v2.model.inbox_rule_create_request import InboxRuleCreateRequest
+from datadog_api_client.v2.model.inbox_rule_data_create import InboxRuleDataCreate
+from datadog_api_client.v2.model.inbox_rule_type import InboxRuleType
+from datadog_api_client.v2.model.security_finding_type import SecurityFindingType
+
+body = InboxRuleCreateRequest(
+    data=InboxRuleDataCreate(
+        attributes=InboxRuleAttributesCreate(
+            action=InboxRuleAction(
+                description="Needs triage",
+            ),
+            enabled=True,
+            name="Example-Security-Monitoring",
+            rule=AutomationRuleScope(
+                finding_types=[
+                    SecurityFindingType.MISCONFIGURATION,
+                ],
+                query="env:staging",
+            ),
+        ),
+        type=InboxRuleType.INBOX_RULES,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_security_findings_automation_inbox_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.create_security_findings_automation_inbox_rule(body=body)
+
+    print(response)

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationDueDateRule.py

@@ -1,18 +1,15 @@
 """
-Delete a due date rule returns "Rule successfully deleted." response
+Delete a due date rule returns "Successfully deleted the due date rule" response
 """
 
-from os import environ
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
-
-# there is a valid "valid_due_date_rule" in the system
-VALID_DUE_DATE_RULE_DATA_ID = environ["VALID_DUE_DATE_RULE_DATA_ID"]
+from uuid import UUID
 
 configuration = Configuration()
 configuration.unstable_operations["delete_security_findings_automation_due_date_rule"] = True
 with ApiClient(configuration) as api_client:
     api_instance = SecurityMonitoringApi(api_client)
     api_instance.delete_security_findings_automation_due_date_rule(
-        rule_id=VALID_DUE_DATE_RULE_DATA_ID,
+        rule_id=UUID("00000000-0000-0000-0000-000000000000"),
     )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationDueDateRule_1294276849.py

@@ -0,0 +1,18 @@
+"""
+Delete a due date rule returns "Rule successfully deleted." response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "valid_due_date_rule" in the system
+VALID_DUE_DATE_RULE_DATA_ID = environ["VALID_DUE_DATE_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_security_findings_automation_due_date_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    api_instance.delete_security_findings_automation_due_date_rule(
+        rule_id=VALID_DUE_DATE_RULE_DATA_ID,
+    )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationInboxRule.py

@@ -0,0 +1,18 @@
+"""
+Delete an inbox rule returns "Successfully deleted the inbox rule" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "valid_inbox_rule" in the system
+VALID_INBOX_RULE_DATA_ID = environ["VALID_INBOX_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_security_findings_automation_inbox_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    api_instance.delete_security_findings_automation_inbox_rule(
+        rule_id=VALID_INBOX_RULE_DATA_ID,
+    )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationMuteRule.py

@@ -1,18 +1,15 @@
 """
-Delete a mute rule returns "Rule successfully deleted." response
+Delete a mute rule returns "Successfully deleted the mute rule" response
 """
 
-from os import environ
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
-
-# there is a valid "valid_mute_rule" in the system
-VALID_MUTE_RULE_DATA_ID = environ["VALID_MUTE_RULE_DATA_ID"]
+from uuid import UUID
 
 configuration = Configuration()
 configuration.unstable_operations["delete_security_findings_automation_mute_rule"] = True
 with ApiClient(configuration) as api_client:
     api_instance = SecurityMonitoringApi(api_client)
     api_instance.delete_security_findings_automation_mute_rule(
-        rule_id=VALID_MUTE_RULE_DATA_ID,
+        rule_id=UUID("00000000-0000-0000-0000-000000000000"),
     )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationMuteRule_4166916016.py

@@ -0,0 +1,18 @@
+"""
+Delete a mute rule returns "Rule successfully deleted." response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "valid_mute_rule" in the system
+VALID_MUTE_RULE_DATA_ID = environ["VALID_MUTE_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_security_findings_automation_mute_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    api_instance.delete_security_findings_automation_mute_rule(
+        rule_id=VALID_MUTE_RULE_DATA_ID,
+    )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationSeverityModifierRule.py

@@ -1,18 +1,15 @@
 """
-Delete a severity modifier rule returns "Rule successfully deleted" response
+Delete a severity modifier rule returns "Successfully deleted the severity modifier rule" response
 """
 
-from os import environ
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
-
-# there is a valid "valid_severity_modifier_rule" in the system
-VALID_SEVERITY_MODIFIER_RULE_DATA_ID = environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]
+from uuid import UUID
 
 configuration = Configuration()
 configuration.unstable_operations["delete_security_findings_automation_severity_modifier_rule"] = True
 with ApiClient(configuration) as api_client:
     api_instance = SecurityMonitoringApi(api_client)
     api_instance.delete_security_findings_automation_severity_modifier_rule(
-        rule_id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
+        rule_id=UUID("00000000-0000-0000-0000-000000000000"),
     )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationSeverityModifierRule_1187257521.py

@@ -0,0 +1,18 @@
+"""
+Delete a severity modifier rule returns "Rule successfully deleted" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "valid_severity_modifier_rule" in the system
+VALID_SEVERITY_MODIFIER_RULE_DATA_ID = environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_security_findings_automation_severity_modifier_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    api_instance.delete_security_findings_automation_severity_modifier_rule(
+        rule_id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
+    )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationTicketCreationRule.py

@@ -1,18 +1,15 @@
 """
-Delete a ticket creation rule returns "Rule successfully deleted." response
+Delete a ticket creation rule returns "Successfully deleted the ticket creation rule" response
 """
 
-from os import environ
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
-
-# there is a valid "valid_ticket_creation_rule" in the system
-VALID_TICKET_CREATION_RULE_DATA_ID = environ["VALID_TICKET_CREATION_RULE_DATA_ID"]
+from uuid import UUID
 
 configuration = Configuration()
 configuration.unstable_operations["delete_security_findings_automation_ticket_creation_rule"] = True
 with ApiClient(configuration) as api_client:
     api_instance = SecurityMonitoringApi(api_client)
     api_instance.delete_security_findings_automation_ticket_creation_rule(
-        rule_id=VALID_TICKET_CREATION_RULE_DATA_ID,
+        rule_id=UUID("00000000-0000-0000-0000-000000000000"),
     )

examples/v2/security-monitoring/DeleteSecurityFindingsAutomationTicketCreationRule_476126190.py

@@ -0,0 +1,18 @@
+"""
+Delete a ticket creation rule returns "Rule successfully deleted." response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "valid_ticket_creation_rule" in the system
+VALID_TICKET_CREATION_RULE_DATA_ID = environ["VALID_TICKET_CREATION_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_security_findings_automation_ticket_creation_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    api_instance.delete_security_findings_automation_ticket_creation_rule(
+        rule_id=VALID_TICKET_CREATION_RULE_DATA_ID,
+    )

examples/v2/security-monitoring/DisableSecurityFindingsAutomationDefaultInboxRule.py

@@ -0,0 +1,16 @@
+"""
+Disable a default inbox rule returns "Successfully disabled the default inbox rule" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+configuration = Configuration()
+configuration.unstable_operations["disable_security_findings_automation_default_inbox_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.disable_security_findings_automation_default_inbox_rule(
+        rule_id="secret_default_rule",
+    )
+
+    print(response)

examples/v2/security-monitoring/EnableSecurityFindingsAutomationDefaultInboxRule.py

@@ -0,0 +1,16 @@
+"""
+Enable a default inbox rule returns "Successfully enabled the default inbox rule" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+configuration = Configuration()
+configuration.unstable_operations["enable_security_findings_automation_default_inbox_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.enable_security_findings_automation_default_inbox_rule(
+        rule_id="secret_default_rule",
+    )
+
+    print(response)

examples/v2/security-monitoring/GetSecurityFindingsAutomationDefaultInboxRule.py

@@ -0,0 +1,16 @@
+"""
+Get a default inbox rule returns "Successfully retrieved the default inbox rule" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+configuration = Configuration()
+configuration.unstable_operations["get_security_findings_automation_default_inbox_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.get_security_findings_automation_default_inbox_rule(
+        rule_id="secret_default_rule",
+    )
+
+    print(response)

examples/v2/security-monitoring/GetSecurityFindingsAutomationInboxRule.py

@@ -0,0 +1,20 @@
+"""
+Get an inbox rule returns "Successfully retrieved the inbox rule" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "valid_inbox_rule" in the system
+VALID_INBOX_RULE_DATA_ID = environ["VALID_INBOX_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["get_security_findings_automation_inbox_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.get_security_findings_automation_inbox_rule(
+        rule_id=VALID_INBOX_RULE_DATA_ID,
+    )
+
+    print(response)

examples/v2/security-monitoring/ListSecurityFindingsAutomationDefaultInboxRules.py

@@ -0,0 +1,14 @@
+"""
+Get all default inbox rules returns "Successfully retrieved the list of default inbox rules" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+configuration = Configuration()
+configuration.unstable_operations["list_security_findings_automation_default_inbox_rules"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.list_security_findings_automation_default_inbox_rules()
+
+    print(response)

examples/v2/security-monitoring/ListSecurityFindingsAutomationInboxRules.py

@@ -0,0 +1,14 @@
+"""
+Get all inbox rules returns "Successfully retrieved the list of inbox rules" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+configuration = Configuration()
+configuration.unstable_operations["list_security_findings_automation_inbox_rules"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.list_security_findings_automation_inbox_rules()
+
+    print(response)

examples/v2/security-monitoring/ReorderSecurityFindingsAutomationInboxRules.py

@@ -0,0 +1,30 @@
+"""
+Reorder inbox rules returns "Successfully reordered the inbox rules" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.inbox_rule_reorder_item import InboxRuleReorderItem
+from datadog_api_client.v2.model.inbox_rule_reorder_request import InboxRuleReorderRequest
+from datadog_api_client.v2.model.inbox_rule_type import InboxRuleType
+
+# there is a valid "valid_inbox_rule" in the system
+VALID_INBOX_RULE_DATA_ID = environ["VALID_INBOX_RULE_DATA_ID"]
+
+body = InboxRuleReorderRequest(
+    data=[
+        InboxRuleReorderItem(
+            id=VALID_INBOX_RULE_DATA_ID,
+            type=InboxRuleType.INBOX_RULES,
+        ),
+    ],
+)
+
+configuration = Configuration()
+configuration.unstable_operations["reorder_security_findings_automation_inbox_rules"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.reorder_security_findings_automation_inbox_rules(body=body)
+
+    print(response)