scc-firewall-manager-sdk 1.15.287__py3-none-any.whl → 1.15.563__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- scc_firewall_manager_sdk/__init__.py +9 -1
- scc_firewall_manager_sdk/api/__init__.py +2 -0
- scc_firewall_manager_sdk/api/ai_assistant_api.py +12 -12
- scc_firewall_manager_sdk/api/asa_access_groups_api.py +12 -12
- scc_firewall_manager_sdk/api/asa_access_rules_api.py +12 -12
- scc_firewall_manager_sdk/api/asa_interfaces_api.py +72 -72
- scc_firewall_manager_sdk/api/audit_logs_api.py +12 -12
- scc_firewall_manager_sdk/api/change_requests_api.py +12 -12
- scc_firewall_manager_sdk/api/changelogs_api.py +12 -12
- scc_firewall_manager_sdk/api/command_line_interface_api.py +24 -24
- scc_firewall_manager_sdk/api/connectors_api.py +12 -313
- scc_firewall_manager_sdk/api/device_health_aggregations_api.py +6 -6
- scc_firewall_manager_sdk/api/device_upgrades_api.py +15 -15
- scc_firewall_manager_sdk/api/events_api.py +358 -0
- scc_firewall_manager_sdk/api/interface_health_aggregations_api.py +6 -6
- scc_firewall_manager_sdk/api/inventory_api.py +48 -48
- scc_firewall_manager_sdk/api/licensing_api.py +626 -0
- scc_firewall_manager_sdk/api/msp_device_upgrades_api.py +53 -24
- scc_firewall_manager_sdk/api/msp_inventory_api.py +48 -48
- scc_firewall_manager_sdk/api/msp_tenant_management_api.py +41 -12
- scc_firewall_manager_sdk/api/msp_user_management_api.py +24 -24
- scc_firewall_manager_sdk/api/remote_access_monitoring_api.py +24 -24
- scc_firewall_manager_sdk/api/tenant_management_api.py +21 -18
- scc_firewall_manager_sdk/api/users_api.py +30 -30
- scc_firewall_manager_sdk/api_client.py +1 -1
- scc_firewall_manager_sdk/configuration.py +1 -1
- scc_firewall_manager_sdk/models/__init__.py +6 -0
- scc_firewall_manager_sdk/models/access_group.py +1 -1
- scc_firewall_manager_sdk/models/cdo_transaction.py +12 -12
- scc_firewall_manager_sdk/models/common_api_error.py +3 -3
- scc_firewall_manager_sdk/models/completion_status_dto.py +104 -0
- scc_firewall_manager_sdk/models/device_license_dto.py +133 -0
- scc_firewall_manager_sdk/models/device_license_page.py +102 -0
- scc_firewall_manager_sdk/models/device_upgrade_status_dto.py +13 -7
- scc_firewall_manager_sdk/models/enable_cd_fmc_for_tenant_request.py +88 -0
- scc_firewall_manager_sdk/models/log_settings.py +1 -1
- scc_firewall_manager_sdk/models/msp_calculate_compatible_upgrade_versions_input.py +1 -1
- scc_firewall_manager_sdk/models/msp_managed_device.py +7 -1
- scc_firewall_manager_sdk/models/msp_managed_device_distinct_attribute_values.py +5 -1
- scc_firewall_manager_sdk/models/msp_upgrade_ftd_devices_input.py +97 -0
- scc_firewall_manager_sdk/models/msp_upgrade_run_dto.py +9 -9
- scc_firewall_manager_sdk/models/msp_upgrade_runs_attribute_values.py +18 -3
- scc_firewall_manager_sdk/models/smart_account.py +90 -0
- scc_firewall_manager_sdk/models/tenant_settings.py +3 -1
- scc_firewall_manager_sdk/models/upgrade_run_dto.py +1 -1
- scc_firewall_manager_sdk/models/upgrade_run_metadata_dto.py +1 -1
- {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/METADATA +1 -1
- {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/RECORD +50 -42
- {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/WHEEL +0 -0
- {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/top_level.txt +0 -0
|
@@ -317,8 +317,8 @@ class ChangelogsApi:
|
|
|
317
317
|
@validate_call
|
|
318
318
|
def get_changelogs(
|
|
319
319
|
self,
|
|
320
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
321
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
320
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
321
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
322
322
|
search_text: Annotated[Optional[StrictStr], Field(description="The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.")] = None,
|
|
323
323
|
time_range: Annotated[Optional[StrictStr], Field(description="The time range for which to retrieve Change Logs. This parameter cannot be used in conjunction with a query on the lastEventDate field.")] = None,
|
|
324
324
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
@@ -339,9 +339,9 @@ class ChangelogsApi:
|
|
|
339
339
|
|
|
340
340
|
Get a list of Change Logs in the Security Cloud Control tenant.
|
|
341
341
|
|
|
342
|
-
:param limit:
|
|
342
|
+
:param limit: Number of results to retrieve.
|
|
343
343
|
:type limit: str
|
|
344
|
-
:param offset:
|
|
344
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
345
345
|
:type offset: str
|
|
346
346
|
:param search_text: The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.
|
|
347
347
|
:type search_text: str
|
|
@@ -405,8 +405,8 @@ class ChangelogsApi:
|
|
|
405
405
|
@validate_call
|
|
406
406
|
def get_changelogs_with_http_info(
|
|
407
407
|
self,
|
|
408
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
409
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
408
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
409
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
410
410
|
search_text: Annotated[Optional[StrictStr], Field(description="The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.")] = None,
|
|
411
411
|
time_range: Annotated[Optional[StrictStr], Field(description="The time range for which to retrieve Change Logs. This parameter cannot be used in conjunction with a query on the lastEventDate field.")] = None,
|
|
412
412
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
@@ -427,9 +427,9 @@ class ChangelogsApi:
|
|
|
427
427
|
|
|
428
428
|
Get a list of Change Logs in the Security Cloud Control tenant.
|
|
429
429
|
|
|
430
|
-
:param limit:
|
|
430
|
+
:param limit: Number of results to retrieve.
|
|
431
431
|
:type limit: str
|
|
432
|
-
:param offset:
|
|
432
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
433
433
|
:type offset: str
|
|
434
434
|
:param search_text: The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.
|
|
435
435
|
:type search_text: str
|
|
@@ -493,8 +493,8 @@ class ChangelogsApi:
|
|
|
493
493
|
@validate_call
|
|
494
494
|
def get_changelogs_without_preload_content(
|
|
495
495
|
self,
|
|
496
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
497
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
496
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
497
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
498
498
|
search_text: Annotated[Optional[StrictStr], Field(description="The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.")] = None,
|
|
499
499
|
time_range: Annotated[Optional[StrictStr], Field(description="The time range for which to retrieve Change Logs. This parameter cannot be used in conjunction with a query on the lastEventDate field.")] = None,
|
|
500
500
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
@@ -515,9 +515,9 @@ class ChangelogsApi:
|
|
|
515
515
|
|
|
516
516
|
Get a list of Change Logs in the Security Cloud Control tenant.
|
|
517
517
|
|
|
518
|
-
:param limit:
|
|
518
|
+
:param limit: Number of results to retrieve.
|
|
519
519
|
:type limit: str
|
|
520
|
-
:param offset:
|
|
520
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
521
521
|
:type offset: str
|
|
522
522
|
:param search_text: The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.
|
|
523
523
|
:type search_text: str
|
|
@@ -1452,8 +1452,8 @@ class CommandLineInterfaceApi:
|
|
|
1452
1452
|
@validate_call
|
|
1453
1453
|
def get_cli_macros(
|
|
1454
1454
|
self,
|
|
1455
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1456
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1455
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
1456
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1457
1457
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1458
1458
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
1459
1459
|
_request_timeout: Union[
|
|
@@ -1473,9 +1473,9 @@ class CommandLineInterfaceApi:
|
|
|
1473
1473
|
|
|
1474
1474
|
Get a list of CLI macros. A CLI macro is a fully-formed CLI command ready to use, or a template of a CLI command you can modify before you run it.
|
|
1475
1475
|
|
|
1476
|
-
:param limit:
|
|
1476
|
+
:param limit: Number of results to retrieve.
|
|
1477
1477
|
:type limit: str
|
|
1478
|
-
:param offset:
|
|
1478
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1479
1479
|
:type offset: str
|
|
1480
1480
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1481
1481
|
:type q: str
|
|
@@ -1536,8 +1536,8 @@ class CommandLineInterfaceApi:
|
|
|
1536
1536
|
@validate_call
|
|
1537
1537
|
def get_cli_macros_with_http_info(
|
|
1538
1538
|
self,
|
|
1539
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1540
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1539
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
1540
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1541
1541
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1542
1542
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
1543
1543
|
_request_timeout: Union[
|
|
@@ -1557,9 +1557,9 @@ class CommandLineInterfaceApi:
|
|
|
1557
1557
|
|
|
1558
1558
|
Get a list of CLI macros. A CLI macro is a fully-formed CLI command ready to use, or a template of a CLI command you can modify before you run it.
|
|
1559
1559
|
|
|
1560
|
-
:param limit:
|
|
1560
|
+
:param limit: Number of results to retrieve.
|
|
1561
1561
|
:type limit: str
|
|
1562
|
-
:param offset:
|
|
1562
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1563
1563
|
:type offset: str
|
|
1564
1564
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1565
1565
|
:type q: str
|
|
@@ -1620,8 +1620,8 @@ class CommandLineInterfaceApi:
|
|
|
1620
1620
|
@validate_call
|
|
1621
1621
|
def get_cli_macros_without_preload_content(
|
|
1622
1622
|
self,
|
|
1623
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1624
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1623
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
1624
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1625
1625
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1626
1626
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
1627
1627
|
_request_timeout: Union[
|
|
@@ -1641,9 +1641,9 @@ class CommandLineInterfaceApi:
|
|
|
1641
1641
|
|
|
1642
1642
|
Get a list of CLI macros. A CLI macro is a fully-formed CLI command ready to use, or a template of a CLI command you can modify before you run it.
|
|
1643
1643
|
|
|
1644
|
-
:param limit:
|
|
1644
|
+
:param limit: Number of results to retrieve.
|
|
1645
1645
|
:type limit: str
|
|
1646
|
-
:param offset:
|
|
1646
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1647
1647
|
:type offset: str
|
|
1648
1648
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1649
1649
|
:type q: str
|
|
@@ -2055,8 +2055,8 @@ class CommandLineInterfaceApi:
|
|
|
2055
2055
|
@validate_call
|
|
2056
2056
|
def get_cli_results(
|
|
2057
2057
|
self,
|
|
2058
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
2059
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
2058
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
2059
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
2060
2060
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
2061
2061
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
2062
2062
|
_request_timeout: Union[
|
|
@@ -2076,9 +2076,9 @@ class CommandLineInterfaceApi:
|
|
|
2076
2076
|
|
|
2077
2077
|
Get a list of results from command lines executed using the [CDO Command Line Interface (CLI)](https://docs.defenseorchestrator.com/c-using-the-cdo-command-line-interface.html). These commands can be executed using either the Security Cloud Control UI or the API.
|
|
2078
2078
|
|
|
2079
|
-
:param limit:
|
|
2079
|
+
:param limit: Number of results to retrieve.
|
|
2080
2080
|
:type limit: str
|
|
2081
|
-
:param offset:
|
|
2081
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
2082
2082
|
:type offset: str
|
|
2083
2083
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
2084
2084
|
:type q: str
|
|
@@ -2139,8 +2139,8 @@ class CommandLineInterfaceApi:
|
|
|
2139
2139
|
@validate_call
|
|
2140
2140
|
def get_cli_results_with_http_info(
|
|
2141
2141
|
self,
|
|
2142
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
2143
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
2142
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
2143
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
2144
2144
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
2145
2145
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
2146
2146
|
_request_timeout: Union[
|
|
@@ -2160,9 +2160,9 @@ class CommandLineInterfaceApi:
|
|
|
2160
2160
|
|
|
2161
2161
|
Get a list of results from command lines executed using the [CDO Command Line Interface (CLI)](https://docs.defenseorchestrator.com/c-using-the-cdo-command-line-interface.html). These commands can be executed using either the Security Cloud Control UI or the API.
|
|
2162
2162
|
|
|
2163
|
-
:param limit:
|
|
2163
|
+
:param limit: Number of results to retrieve.
|
|
2164
2164
|
:type limit: str
|
|
2165
|
-
:param offset:
|
|
2165
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
2166
2166
|
:type offset: str
|
|
2167
2167
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
2168
2168
|
:type q: str
|
|
@@ -2223,8 +2223,8 @@ class CommandLineInterfaceApi:
|
|
|
2223
2223
|
@validate_call
|
|
2224
2224
|
def get_cli_results_without_preload_content(
|
|
2225
2225
|
self,
|
|
2226
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
2227
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
2226
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
2227
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
2228
2228
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
2229
2229
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
2230
2230
|
_request_timeout: Union[
|
|
@@ -2244,9 +2244,9 @@ class CommandLineInterfaceApi:
|
|
|
2244
2244
|
|
|
2245
2245
|
Get a list of results from command lines executed using the [CDO Command Line Interface (CLI)](https://docs.defenseorchestrator.com/c-using-the-cdo-command-line-interface.html). These commands can be executed using either the Security Cloud Control UI or the API.
|
|
2246
2246
|
|
|
2247
|
-
:param limit:
|
|
2247
|
+
:param limit: Number of results to retrieve.
|
|
2248
2248
|
:type limit: str
|
|
2249
|
-
:param offset:
|
|
2249
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
2250
2250
|
:type offset: str
|
|
2251
2251
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
2252
2252
|
:type q: str
|
|
@@ -21,7 +21,6 @@ from pydantic import Field, StrictStr
|
|
|
21
21
|
from typing import List, Optional
|
|
22
22
|
from typing_extensions import Annotated
|
|
23
23
|
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
|
|
24
|
-
from scc_firewall_manager_sdk.models.page import Page
|
|
25
24
|
from scc_firewall_manager_sdk.models.sdc import Sdc
|
|
26
25
|
from scc_firewall_manager_sdk.models.sdc_create_input import SdcCreateInput
|
|
27
26
|
from scc_firewall_manager_sdk.models.sdc_page import SdcPage
|
|
@@ -874,8 +873,8 @@ class ConnectorsApi:
|
|
|
874
873
|
@validate_call
|
|
875
874
|
def get_sdcs(
|
|
876
875
|
self,
|
|
877
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
878
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
876
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
877
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
879
878
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
880
879
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
881
880
|
_request_timeout: Union[
|
|
@@ -895,9 +894,9 @@ class ConnectorsApi:
|
|
|
895
894
|
|
|
896
895
|
Get a list of on-prem SDCs in the Security Cloud Control tenant.
|
|
897
896
|
|
|
898
|
-
:param limit:
|
|
897
|
+
:param limit: Number of results to retrieve.
|
|
899
898
|
:type limit: str
|
|
900
|
-
:param offset:
|
|
899
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
901
900
|
:type offset: str
|
|
902
901
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
903
902
|
:type q: str
|
|
@@ -957,8 +956,8 @@ class ConnectorsApi:
|
|
|
957
956
|
@validate_call
|
|
958
957
|
def get_sdcs_with_http_info(
|
|
959
958
|
self,
|
|
960
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
961
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
959
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
960
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
962
961
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
963
962
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
964
963
|
_request_timeout: Union[
|
|
@@ -978,9 +977,9 @@ class ConnectorsApi:
|
|
|
978
977
|
|
|
979
978
|
Get a list of on-prem SDCs in the Security Cloud Control tenant.
|
|
980
979
|
|
|
981
|
-
:param limit:
|
|
980
|
+
:param limit: Number of results to retrieve.
|
|
982
981
|
:type limit: str
|
|
983
|
-
:param offset:
|
|
982
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
984
983
|
:type offset: str
|
|
985
984
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
986
985
|
:type q: str
|
|
@@ -1040,8 +1039,8 @@ class ConnectorsApi:
|
|
|
1040
1039
|
@validate_call
|
|
1041
1040
|
def get_sdcs_without_preload_content(
|
|
1042
1041
|
self,
|
|
1043
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1044
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="
|
|
1042
|
+
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
|
|
1043
|
+
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1045
1044
|
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1046
1045
|
sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
|
|
1047
1046
|
_request_timeout: Union[
|
|
@@ -1061,9 +1060,9 @@ class ConnectorsApi:
|
|
|
1061
1060
|
|
|
1062
1061
|
Get a list of on-prem SDCs in the Security Cloud Control tenant.
|
|
1063
1062
|
|
|
1064
|
-
:param limit:
|
|
1063
|
+
:param limit: Number of results to retrieve.
|
|
1065
1064
|
:type limit: str
|
|
1066
|
-
:param offset:
|
|
1065
|
+
:param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1067
1066
|
:type offset: str
|
|
1068
1067
|
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1069
1068
|
:type q: str
|
|
@@ -1195,306 +1194,6 @@ class ConnectorsApi:
|
|
|
1195
1194
|
|
|
1196
1195
|
|
|
1197
1196
|
|
|
1198
|
-
@validate_call
|
|
1199
|
-
def get_search_reports(
|
|
1200
|
-
self,
|
|
1201
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
|
|
1202
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1203
|
-
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1204
|
-
_request_timeout: Union[
|
|
1205
|
-
None,
|
|
1206
|
-
Annotated[StrictFloat, Field(gt=0)],
|
|
1207
|
-
Tuple[
|
|
1208
|
-
Annotated[StrictFloat, Field(gt=0)],
|
|
1209
|
-
Annotated[StrictFloat, Field(gt=0)]
|
|
1210
|
-
]
|
|
1211
|
-
] = None,
|
|
1212
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1213
|
-
_content_type: Optional[StrictStr] = None,
|
|
1214
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1215
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1216
|
-
) -> Page:
|
|
1217
|
-
"""Get event search reports
|
|
1218
|
-
|
|
1219
|
-
Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
|
|
1220
|
-
|
|
1221
|
-
:param limit: The number of results to retrieve.
|
|
1222
|
-
:type limit: str
|
|
1223
|
-
:param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1224
|
-
:type offset: str
|
|
1225
|
-
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1226
|
-
:type q: str
|
|
1227
|
-
:param _request_timeout: timeout setting for this request. If one
|
|
1228
|
-
number provided, it will be total request
|
|
1229
|
-
timeout. It can also be a pair (tuple) of
|
|
1230
|
-
(connection, read) timeouts.
|
|
1231
|
-
:type _request_timeout: int, tuple(int, int), optional
|
|
1232
|
-
:param _request_auth: set to override the auth_settings for an a single
|
|
1233
|
-
request; this effectively ignores the
|
|
1234
|
-
authentication in the spec for a single request.
|
|
1235
|
-
:type _request_auth: dict, optional
|
|
1236
|
-
:param _content_type: force content-type for the request.
|
|
1237
|
-
:type _content_type: str, Optional
|
|
1238
|
-
:param _headers: set to override the headers for a single
|
|
1239
|
-
request; this effectively ignores the headers
|
|
1240
|
-
in the spec for a single request.
|
|
1241
|
-
:type _headers: dict, optional
|
|
1242
|
-
:param _host_index: set to override the host_index for a single
|
|
1243
|
-
request; this effectively ignores the host_index
|
|
1244
|
-
in the spec for a single request.
|
|
1245
|
-
:type _host_index: int, optional
|
|
1246
|
-
:return: Returns the result object.
|
|
1247
|
-
""" # noqa: E501
|
|
1248
|
-
|
|
1249
|
-
_param = self._get_search_reports_serialize(
|
|
1250
|
-
limit=limit,
|
|
1251
|
-
offset=offset,
|
|
1252
|
-
q=q,
|
|
1253
|
-
_request_auth=_request_auth,
|
|
1254
|
-
_content_type=_content_type,
|
|
1255
|
-
_headers=_headers,
|
|
1256
|
-
_host_index=_host_index
|
|
1257
|
-
)
|
|
1258
|
-
|
|
1259
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
|
1260
|
-
'200': "Page",
|
|
1261
|
-
'401': "AuthenticationError",
|
|
1262
|
-
'500': "CommonApiError",
|
|
1263
|
-
}
|
|
1264
|
-
response_data = self.api_client.call_api(
|
|
1265
|
-
*_param,
|
|
1266
|
-
_request_timeout=_request_timeout
|
|
1267
|
-
)
|
|
1268
|
-
response_data.read()
|
|
1269
|
-
return self.api_client.response_deserialize(
|
|
1270
|
-
response_data=response_data,
|
|
1271
|
-
response_types_map=_response_types_map,
|
|
1272
|
-
).data
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
@validate_call
|
|
1276
|
-
def get_search_reports_with_http_info(
|
|
1277
|
-
self,
|
|
1278
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
|
|
1279
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1280
|
-
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1281
|
-
_request_timeout: Union[
|
|
1282
|
-
None,
|
|
1283
|
-
Annotated[StrictFloat, Field(gt=0)],
|
|
1284
|
-
Tuple[
|
|
1285
|
-
Annotated[StrictFloat, Field(gt=0)],
|
|
1286
|
-
Annotated[StrictFloat, Field(gt=0)]
|
|
1287
|
-
]
|
|
1288
|
-
] = None,
|
|
1289
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1290
|
-
_content_type: Optional[StrictStr] = None,
|
|
1291
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1292
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1293
|
-
) -> ApiResponse[Page]:
|
|
1294
|
-
"""Get event search reports
|
|
1295
|
-
|
|
1296
|
-
Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
|
|
1297
|
-
|
|
1298
|
-
:param limit: The number of results to retrieve.
|
|
1299
|
-
:type limit: str
|
|
1300
|
-
:param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1301
|
-
:type offset: str
|
|
1302
|
-
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1303
|
-
:type q: str
|
|
1304
|
-
:param _request_timeout: timeout setting for this request. If one
|
|
1305
|
-
number provided, it will be total request
|
|
1306
|
-
timeout. It can also be a pair (tuple) of
|
|
1307
|
-
(connection, read) timeouts.
|
|
1308
|
-
:type _request_timeout: int, tuple(int, int), optional
|
|
1309
|
-
:param _request_auth: set to override the auth_settings for an a single
|
|
1310
|
-
request; this effectively ignores the
|
|
1311
|
-
authentication in the spec for a single request.
|
|
1312
|
-
:type _request_auth: dict, optional
|
|
1313
|
-
:param _content_type: force content-type for the request.
|
|
1314
|
-
:type _content_type: str, Optional
|
|
1315
|
-
:param _headers: set to override the headers for a single
|
|
1316
|
-
request; this effectively ignores the headers
|
|
1317
|
-
in the spec for a single request.
|
|
1318
|
-
:type _headers: dict, optional
|
|
1319
|
-
:param _host_index: set to override the host_index for a single
|
|
1320
|
-
request; this effectively ignores the host_index
|
|
1321
|
-
in the spec for a single request.
|
|
1322
|
-
:type _host_index: int, optional
|
|
1323
|
-
:return: Returns the result object.
|
|
1324
|
-
""" # noqa: E501
|
|
1325
|
-
|
|
1326
|
-
_param = self._get_search_reports_serialize(
|
|
1327
|
-
limit=limit,
|
|
1328
|
-
offset=offset,
|
|
1329
|
-
q=q,
|
|
1330
|
-
_request_auth=_request_auth,
|
|
1331
|
-
_content_type=_content_type,
|
|
1332
|
-
_headers=_headers,
|
|
1333
|
-
_host_index=_host_index
|
|
1334
|
-
)
|
|
1335
|
-
|
|
1336
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
|
1337
|
-
'200': "Page",
|
|
1338
|
-
'401': "AuthenticationError",
|
|
1339
|
-
'500': "CommonApiError",
|
|
1340
|
-
}
|
|
1341
|
-
response_data = self.api_client.call_api(
|
|
1342
|
-
*_param,
|
|
1343
|
-
_request_timeout=_request_timeout
|
|
1344
|
-
)
|
|
1345
|
-
response_data.read()
|
|
1346
|
-
return self.api_client.response_deserialize(
|
|
1347
|
-
response_data=response_data,
|
|
1348
|
-
response_types_map=_response_types_map,
|
|
1349
|
-
)
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
@validate_call
|
|
1353
|
-
def get_search_reports_without_preload_content(
|
|
1354
|
-
self,
|
|
1355
|
-
limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
|
|
1356
|
-
offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
|
|
1357
|
-
q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
|
|
1358
|
-
_request_timeout: Union[
|
|
1359
|
-
None,
|
|
1360
|
-
Annotated[StrictFloat, Field(gt=0)],
|
|
1361
|
-
Tuple[
|
|
1362
|
-
Annotated[StrictFloat, Field(gt=0)],
|
|
1363
|
-
Annotated[StrictFloat, Field(gt=0)]
|
|
1364
|
-
]
|
|
1365
|
-
] = None,
|
|
1366
|
-
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1367
|
-
_content_type: Optional[StrictStr] = None,
|
|
1368
|
-
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1369
|
-
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1370
|
-
) -> RESTResponseType:
|
|
1371
|
-
"""Get event search reports
|
|
1372
|
-
|
|
1373
|
-
Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
|
|
1374
|
-
|
|
1375
|
-
:param limit: The number of results to retrieve.
|
|
1376
|
-
:type limit: str
|
|
1377
|
-
:param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
|
|
1378
|
-
:type offset: str
|
|
1379
|
-
:param q: The query to execute. Use the Lucene Query Syntax to construct your query.
|
|
1380
|
-
:type q: str
|
|
1381
|
-
:param _request_timeout: timeout setting for this request. If one
|
|
1382
|
-
number provided, it will be total request
|
|
1383
|
-
timeout. It can also be a pair (tuple) of
|
|
1384
|
-
(connection, read) timeouts.
|
|
1385
|
-
:type _request_timeout: int, tuple(int, int), optional
|
|
1386
|
-
:param _request_auth: set to override the auth_settings for an a single
|
|
1387
|
-
request; this effectively ignores the
|
|
1388
|
-
authentication in the spec for a single request.
|
|
1389
|
-
:type _request_auth: dict, optional
|
|
1390
|
-
:param _content_type: force content-type for the request.
|
|
1391
|
-
:type _content_type: str, Optional
|
|
1392
|
-
:param _headers: set to override the headers for a single
|
|
1393
|
-
request; this effectively ignores the headers
|
|
1394
|
-
in the spec for a single request.
|
|
1395
|
-
:type _headers: dict, optional
|
|
1396
|
-
:param _host_index: set to override the host_index for a single
|
|
1397
|
-
request; this effectively ignores the host_index
|
|
1398
|
-
in the spec for a single request.
|
|
1399
|
-
:type _host_index: int, optional
|
|
1400
|
-
:return: Returns the result object.
|
|
1401
|
-
""" # noqa: E501
|
|
1402
|
-
|
|
1403
|
-
_param = self._get_search_reports_serialize(
|
|
1404
|
-
limit=limit,
|
|
1405
|
-
offset=offset,
|
|
1406
|
-
q=q,
|
|
1407
|
-
_request_auth=_request_auth,
|
|
1408
|
-
_content_type=_content_type,
|
|
1409
|
-
_headers=_headers,
|
|
1410
|
-
_host_index=_host_index
|
|
1411
|
-
)
|
|
1412
|
-
|
|
1413
|
-
_response_types_map: Dict[str, Optional[str]] = {
|
|
1414
|
-
'200': "Page",
|
|
1415
|
-
'401': "AuthenticationError",
|
|
1416
|
-
'500': "CommonApiError",
|
|
1417
|
-
}
|
|
1418
|
-
response_data = self.api_client.call_api(
|
|
1419
|
-
*_param,
|
|
1420
|
-
_request_timeout=_request_timeout
|
|
1421
|
-
)
|
|
1422
|
-
return response_data.response
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
def _get_search_reports_serialize(
|
|
1426
|
-
self,
|
|
1427
|
-
limit,
|
|
1428
|
-
offset,
|
|
1429
|
-
q,
|
|
1430
|
-
_request_auth,
|
|
1431
|
-
_content_type,
|
|
1432
|
-
_headers,
|
|
1433
|
-
_host_index,
|
|
1434
|
-
) -> RequestSerialized:
|
|
1435
|
-
|
|
1436
|
-
_host = None
|
|
1437
|
-
|
|
1438
|
-
_collection_formats: Dict[str, str] = {
|
|
1439
|
-
}
|
|
1440
|
-
|
|
1441
|
-
_path_params: Dict[str, str] = {}
|
|
1442
|
-
_query_params: List[Tuple[str, str]] = []
|
|
1443
|
-
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1444
|
-
_form_params: List[Tuple[str, str]] = []
|
|
1445
|
-
_files: Dict[str, str] = {}
|
|
1446
|
-
_body_params: Optional[bytes] = None
|
|
1447
|
-
|
|
1448
|
-
# process the path parameters
|
|
1449
|
-
# process the query parameters
|
|
1450
|
-
if limit is not None:
|
|
1451
|
-
|
|
1452
|
-
_query_params.append(('limit', limit))
|
|
1453
|
-
|
|
1454
|
-
if offset is not None:
|
|
1455
|
-
|
|
1456
|
-
_query_params.append(('offset', offset))
|
|
1457
|
-
|
|
1458
|
-
if q is not None:
|
|
1459
|
-
|
|
1460
|
-
_query_params.append(('q', q))
|
|
1461
|
-
|
|
1462
|
-
# process the header parameters
|
|
1463
|
-
# process the form parameters
|
|
1464
|
-
# process the body parameter
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
# set the HTTP header `Accept`
|
|
1468
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1469
|
-
[
|
|
1470
|
-
'application/json'
|
|
1471
|
-
]
|
|
1472
|
-
)
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
# authentication setting
|
|
1476
|
-
_auth_settings: List[str] = [
|
|
1477
|
-
'bearerAuth'
|
|
1478
|
-
]
|
|
1479
|
-
|
|
1480
|
-
return self.api_client.param_serialize(
|
|
1481
|
-
method='GET',
|
|
1482
|
-
resource_path='/v1/events/reports',
|
|
1483
|
-
path_params=_path_params,
|
|
1484
|
-
query_params=_query_params,
|
|
1485
|
-
header_params=_header_params,
|
|
1486
|
-
body=_body_params,
|
|
1487
|
-
post_params=_form_params,
|
|
1488
|
-
files=_files,
|
|
1489
|
-
auth_settings=_auth_settings,
|
|
1490
|
-
collection_formats=_collection_formats,
|
|
1491
|
-
_host=_host,
|
|
1492
|
-
_request_auth=_request_auth
|
|
1493
|
-
)
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
1197
|
@validate_call
|
|
1499
1198
|
def modify_sdc(
|
|
1500
1199
|
self,
|