taegis-sdk-python 1.2.9__tar.gz → 1.2.11__tar.gz

{taegis_sdk_python-1.2.9/taegis_sdk_python.egg-info → taegis_sdk_python-1.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: taegis-sdk-python
-Version: 1.2.9
+Version: 1.2.11
 Summary: Taegis Python SDK
 Home-page: https://github.com/secureworks/taegis-sdk-python
 Author: Secureworks

taegis_sdk_python-1.2.11/taegis_sdk_python/_version.py

@@ -0,0 +1 @@
+__version__ = "v1.2.11"

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/__init__.py

@@ -51,6 +51,7 @@ from taegis_sdk_python.services.sharelinks import SharelinksService
 from taegis_sdk_python.services.subjects import SubjectsService
 from taegis_sdk_python.services.tenant_profiles import TenantProfilesService
 from taegis_sdk_python.services.tenants import TenantsService
+from taegis_sdk_python.services.tenants4 import Tenants4Service
 from taegis_sdk_python.services.threat import ThreatService
 from taegis_sdk_python.services.threat_score import ThreatScoreService
 from taegis_sdk_python.services.trip import TripService
@@ -151,6 +152,7 @@ class GraphQLService:
         self._subjects = None
         self._tenant_profiles = None
         self._tenants = None
+        self._tenants4 = None
         self._threat = None
         self._threat_score = None
         self._trip = None
@@ -534,6 +536,13 @@ class GraphQLService:
             self._tenants = TenantsService(self)
         return self._tenants
 
+    @property
+    def tenants4(self):
+        """Tenants Service Endpoint."""
+        if not self._tenants4:
+            self._tenants4 = Tenants4Service(self)
+        return self._tenants4
+
     @property
     def threat(self):
         """Threat Service Endpoint."""

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/clients/mutations.py

@@ -46,7 +46,7 @@ class TaegisSDKClientsMutation:
             return NewClient.from_dict(result.get(endpoint))
         raise GraphQLNoRowsInResultSetError("for mutation createClient")
 
-    def rotate_client_secret(self, id_: str) -> NewClient:
+    def rotate_client_secret(self, id_: str, secret: Optional[str] = None) -> NewClient:
         """Generate a new secret for an existing client."""
         endpoint = "rotateClientSecret"
 
@@ -54,6 +54,7 @@ class TaegisSDKClientsMutation:
             endpoint=endpoint,
             variables={
                 "id": prepare_input(id_),
+                "secret": prepare_input(secret),
             },
             output=build_output_string(NewClient),
         )
@@ -61,6 +62,21 @@ class TaegisSDKClientsMutation:
             return NewClient.from_dict(result.get(endpoint))
         raise GraphQLNoRowsInResultSetError("for mutation rotateClientSecret")
 
+    def force_rotate_client_secret(self, id_: str) -> NewClient:
+        """Force rotate a new secret for an existing client.."""
+        endpoint = "forceRotateClientSecret"
+
+        result = self.service.execute_mutation(
+            endpoint=endpoint,
+            variables={
+                "id": prepare_input(id_),
+            },
+            output=build_output_string(NewClient),
+        )
+        if result.get(endpoint) is not None:
+            return NewClient.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for mutation forceRotateClientSecret")
+
     def append_client_roles(
         self, id_: str, roles: List[ClientRoleAssignmentInput]
     ) -> Client:

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/clients/types.py

@@ -199,6 +199,7 @@ class Client:
     token_request_count: Optional[int] = field(
         default=None, metadata=config(field_name="tokenRequestCount")
     )
+    enabled: Optional[bool] = field(default=None, metadata=config(field_name="enabled"))
     role_assignments: Optional[List[ClientRoleAssignment]] = field(
         default=None,
         metadata=config(

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/endpoint_command_manager/mutations.py

@@ -186,3 +186,33 @@ class TaegisSDKEndpointCommandManagerMutation:
         if result.get(endpoint) is not None:
             return Result.from_dict(result.get(endpoint))
         raise GraphQLNoRowsInResultSetError("for mutation sendUnblockUser")
+
+    def release_file(self, input_: QuarantinedFileCommandInput) -> Result:
+        """release a file from quarantine."""
+        endpoint = "releaseFile"
+
+        result = self.service.execute_mutation(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(Result),
+        )
+        if result.get(endpoint) is not None:
+            return Result.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for mutation releaseFile")
+
+    def delete_file(self, input_: QuarantinedFileCommandInput) -> Result:
+        """issue the command to the endpoint to delete a file that has been quarantined."""
+        endpoint = "deleteFile"
+
+        result = self.service.execute_mutation(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(Result),
+        )
+        if result.get(endpoint) is not None:
+            return Result.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for mutation deleteFile")

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/endpoint_command_manager/types.py

@@ -183,6 +183,24 @@ class IsolationExclusionRuleResult:
     reason: Optional[str] = field(default=None, metadata=config(field_name="Reason"))
 
 
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class QuarantinedFileCommandInput:
+    """QuarantinedFileCommandInput."""
+
+    endpoint_id: Optional[str] = field(
+        default=None, metadata=config(field_name="EndpointID")
+    )
+    file_id: Optional[str] = field(default=None, metadata=config(field_name="FileID"))
+    file_path: Optional[str] = field(
+        default=None, metadata=config(field_name="FilePath")
+    )
+    reason: Optional[str] = field(default=None, metadata=config(field_name="Reason"))
+    request_id: Optional[str] = field(
+        default=None, metadata=config(field_name="RequestID")
+    )
+
+
 @dataclass_json
 @dataclass(order=True, eq=True, frozen=True)
 class HashAndType:

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/event_search/types.py

@@ -33,7 +33,20 @@ class AuxiliaryEventsByIDOptions:
     """AuxiliaryEventsByIDOptions."""
 
     search_events_api_first: Optional[bool] = field(
-        default=None, metadata=config(field_name="searchEventsAPIFirst")
+        default=None,
+        metadata=config(
+            metadata={
+                "deprecated": True,
+                "deprecation_reason": "Events-API is now used automatically when needed, so the searchEventsAPIFirst option is no longer used.",
+            },
+            field_name="searchEventsAPIFirst",
+        ),
+    )
+    fields: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="fields")
+    )
+    skip_events_api_fallback: Optional[bool] = field(
+        default=None, metadata=config(field_name="skipEventsAPIFallback")
     )
 
 
@@ -69,14 +82,7 @@ class GetEventByIDRequestInput:
     ids: Optional[List[str]] = field(default=None, metadata=config(field_name="ids"))
     alert_id: Optional[str] = field(default=None, metadata=config(field_name="alertId"))
     options: Optional[AuxiliaryEventsByIDOptions] = field(
-        default=None,
-        metadata=config(
-            metadata={
-                "deprecated": True,
-                "deprecation_reason": "Events-API is now used automatically when needed, so the searchEventsAPIFirst option is no longer used.",
-            },
-            field_name="options",
-        ),
+        default=None, metadata=config(field_name="options")
     )
 
 

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/events/queries.py

@@ -64,22 +64,3 @@ class TaegisSDKEventsQuery:
         if result.get(endpoint) is not None:
             return EventQuery.from_dict(result.get(endpoint))
         raise GraphQLNoRowsInResultSetError("for query eventQuery")
-
-    def event_queries(
-        self, metadata: Optional[Dict[str, Any]] = None
-    ) -> List[EventQuery]:
-        """Provide a catalog of cached queries.."""
-        endpoint = "eventQueries"
-
-        result = self.service.execute_query(
-            endpoint=endpoint,
-            variables={
-                "metadata": prepare_input(metadata),
-            },
-            output=build_output_string(EventQuery),
-        )
-        if result.get(endpoint) is not None:
-            return EventQuery.schema().load(
-                [r or {} for r in result.get(endpoint)], many=True
-            )
-        raise GraphQLNoRowsInResultSetError("for query eventQueries")

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/tenant_profiles/types.py

@@ -74,6 +74,7 @@ class SecurityControlServiceMtp(str, Enum):
     SECURE_EMAIL_GATEWAY = "SECURE_EMAIL_GATEWAY"
     VPN_GATEWAY = "VPN_GATEWAY"
     VULNERABILITY_SCANNING = "VULNERABILITY_SCANNING"
+    DOMAIN_CONTROLLER = "DOMAIN_CONTROLLER"
     OTHER = "OTHER"
 
 

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/tenants/__init__.py

@@ -1,4 +1,4 @@
-""""Investigations Service."""
+""""Tenants Service."""
 
 from __future__ import annotations
 

{taegis_sdk_python-1.2.9 → taegis_sdk_python-1.2.11}/taegis_sdk_python/services/tenants/types.py

@@ -108,6 +108,13 @@ class SSOConnectionStatus(str, Enum):
     DISABLED = "Disabled"
 
 
+class ExternalProvider(str, Enum):
+    """ExternalProvider."""
+
+    AUTH0 = "AUTH0"
+    COGNITO = "COGNITO"
+
+
 class Auth0DomainType(str, Enum):
     """Auth0DomainType."""
 
@@ -1124,65 +1131,6 @@ class TenantSSOConnectionQueryInput:
     )
 
 
-@dataclass_json
-@dataclass(order=True, eq=True, frozen=True)
-class SSOConnection:
-    """SSOConnection."""
-
-    id: Optional[str] = field(default=None, metadata=config(field_name="id"))
-    name: Optional[str] = field(default=None, metadata=config(field_name="name"))
-    external_name: Optional[str] = field(
-        default=None, metadata=config(field_name="externalName")
-    )
-    external_id: Optional[str] = field(
-        default=None, metadata=config(field_name="externalID")
-    )
-    tenant_id: Optional[str] = field(
-        default=None, metadata=config(field_name="tenantID")
-    )
-    updated_at: Optional[str] = field(
-        default=None, metadata=config(field_name="updatedAt")
-    )
-    created_at: Optional[str] = field(
-        default=None, metadata=config(field_name="createdAt")
-    )
-    cert_name: Optional[str] = field(
-        default=None, metadata=config(field_name="certName")
-    )
-    expires_at: Optional[str] = field(
-        default=None, metadata=config(field_name="expiresAt")
-    )
-    not_before: Optional[str] = field(
-        default=None, metadata=config(field_name="notBefore")
-    )
-    issuer: Optional[str] = field(default=None, metadata=config(field_name="issuer"))
-    subject: Optional[str] = field(default=None, metadata=config(field_name="subject"))
-    domains: Optional[List[str]] = field(
-        default=None, metadata=config(field_name="domains")
-    )
-    testers: Optional[List[str]] = field(
-        default=None, metadata=config(field_name="testers")
-    )
-    type: Optional[SSOConnectionType] = field(
-        default=None, metadata=config(field_name="type")
-    )
-    status: Optional[SSOConnectionStatus] = field(
-        default=None, metadata=config(field_name="status")
-    )
-    environment: Optional[SSOEnvironment] = field(
-        default=None, metadata=config(field_name="environment")
-    )
-    sso_connection_parameters: Optional[SSOConnectionParameters] = field(
-        default=None, metadata=config(field_name="ssoConnectionParameters")
-    )
-    sso_connection_idp_config: Optional[SSOConnectionConfiguration] = field(
-        default=None, metadata=config(field_name="ssoConnectionIDPConfig")
-    )
-    auth0_domain_type: Optional[Auth0DomainType] = field(
-        default=None, metadata=config(field_name="auth0DomainType")
-    )
-
-
 @dataclass_json
 @dataclass(order=True, eq=True, frozen=True)
 class Tenant:
@@ -1273,6 +1221,68 @@ class Tenant:
     )
 
 
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class SSOConnection:
+    """SSOConnection."""
+
+    id: Optional[str] = field(default=None, metadata=config(field_name="id"))
+    name: Optional[str] = field(default=None, metadata=config(field_name="name"))
+    external_name: Optional[str] = field(
+        default=None, metadata=config(field_name="externalName")
+    )
+    external_id: Optional[str] = field(
+        default=None, metadata=config(field_name="externalID")
+    )
+    tenant_id: Optional[str] = field(
+        default=None, metadata=config(field_name="tenantID")
+    )
+    updated_at: Optional[str] = field(
+        default=None, metadata=config(field_name="updatedAt")
+    )
+    created_at: Optional[str] = field(
+        default=None, metadata=config(field_name="createdAt")
+    )
+    cert_name: Optional[str] = field(
+        default=None, metadata=config(field_name="certName")
+    )
+    expires_at: Optional[str] = field(
+        default=None, metadata=config(field_name="expiresAt")
+    )
+    not_before: Optional[str] = field(
+        default=None, metadata=config(field_name="notBefore")
+    )
+    issuer: Optional[str] = field(default=None, metadata=config(field_name="issuer"))
+    subject: Optional[str] = field(default=None, metadata=config(field_name="subject"))
+    domains: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="domains")
+    )
+    testers: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="testers")
+    )
+    type: Optional[SSOConnectionType] = field(
+        default=None, metadata=config(field_name="type")
+    )
+    status: Optional[SSOConnectionStatus] = field(
+        default=None, metadata=config(field_name="status")
+    )
+    environment: Optional[SSOEnvironment] = field(
+        default=None, metadata=config(field_name="environment")
+    )
+    external_provider: Optional[ExternalProvider] = field(
+        default=None, metadata=config(field_name="externalProvider")
+    )
+    sso_connection_parameters: Optional[SSOConnectionParameters] = field(
+        default=None, metadata=config(field_name="ssoConnectionParameters")
+    )
+    sso_connection_idp_config: Optional[SSOConnectionConfiguration] = field(
+        default=None, metadata=config(field_name="ssoConnectionIDPConfig")
+    )
+    auth0_domain_type: Optional[Auth0DomainType] = field(
+        default=None, metadata=config(field_name="auth0DomainType")
+    )
+
+
 @dataclass_json
 @dataclass(order=True, eq=True, frozen=True)
 class TenantsQuery:

taegis_sdk_python-1.2.11/taegis_sdk_python/services/tenants4/__init__.py

@@ -0,0 +1,38 @@
+""""TenantsV4 Service."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from taegis_sdk_python._consts import TAEGIS_TENANTS_URLS
+from taegis_sdk_python.service_core import ServiceCore
+from taegis_sdk_python.services.tenants4.mutations import TaegisSDKTenants4Mutation
+from taegis_sdk_python.services.tenants4.queries import TaegisSDKTenants4Query
+from taegis_sdk_python.services.tenants4.subscriptions import (
+    TaegisSDKTenants4Subscription,
+)
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services import GraphQLService
+
+
+class Tenants4Service(ServiceCore):
+    """Taegis Tenants4 Service."""
+
+    @property
+    def query(self):
+        if not self._queries:
+            self._queries = TaegisSDKTenants4Query(self)
+        return self._queries
+
+    @property
+    def mutation(self):
+        if not self._mutations:
+            self._mutations = TaegisSDKTenants4Mutation(self)
+        return self._mutations
+
+    @property
+    def subscription(self):
+        if not self._subscriptions:
+            self._subscriptions = TaegisSDKTenants4Subscription(self)
+        return self._subscriptions

taegis_sdk_python-1.2.11/taegis_sdk_python/services/tenants4/mutations.py

@@ -0,0 +1,31 @@
+"""Tenants4 Mutation."""
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+from taegis_sdk_python.services.tenants4.types import *
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.tenants4 import Tenants4Service
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKTenants4Mutation:
+    """Taegis Tenants4 Mutation operations."""
+
+    def __init__(self, service: Tenants4Service):
+        self.service = service

taegis_sdk_python-1.2.11/taegis_sdk_python/services/tenants4/queries.py

@@ -0,0 +1,70 @@
+"""Tenants4 Query."""
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+from taegis_sdk_python.services.tenants4.types import *
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.tenants4 import Tenants4Service
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKTenants4Query:
+    """Taegis Tenants4 Query operations."""
+
+    def __init__(self, service: Tenants4Service):
+        self.service = service
+
+    def tenants(self, tenants_query: TenantsQuery) -> TenantResults:
+        """Allows to query tenants using various filters, if running on a public endpoint, this results will be filtered to show only tenants that the subject has access to."""
+        endpoint = "tenants"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "tenantsQuery": prepare_input(tenants_query),
+            },
+            output=build_output_string(TenantResults),
+        )
+        if result.get(endpoint) is not None:
+            return TenantResults.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query tenants")
+
+    def tenant(self, id_: str) -> TenantV4:
+        """Retrieves a single tenant, tenant won't be returned if the subject does not have access to it (and requesting on an endpoint with authorization enabled)."""
+        endpoint = "tenant"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "id": prepare_input(id_),
+            },
+            output=build_output_string(TenantV4),
+        )
+        if result.get(endpoint) is not None:
+            return TenantV4.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query tenant")
+
+    def available_regions(self) -> List[TenantRegion]:
+        """Returns the regions where the tenant in XTC can be enabled at (excluding any regions currently enabled at), If a partner tenant id is provided in XTC, this returns the regions where the partner can enable children at. If more than one tenant is provided in XTC, then only the first one will be provided. If no XTC is provided, error will be returned."""
+        endpoint = "availableRegions"
+
+        result = self.service.execute_query(endpoint=endpoint, variables={}, output="")
+        if result.get(endpoint) is not None:
+            return [TenantRegion(r) for r in result.get(endpoint)]
+        raise GraphQLNoRowsInResultSetError("for query availableRegions")

taegis_sdk_python-1.2.11/taegis_sdk_python/services/tenants4/subscriptions.py

@@ -0,0 +1,31 @@
+"""Tenants4 Subscription."""
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+from taegis_sdk_python.services.tenants4.types import *
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.tenants4 import Tenants4Service
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKTenants4Subscription:
+    """Taegis Tenants4 Subscription operations."""
+
+    def __init__(self, service: Tenants4Service):
+        self.service = service