js7-client-python 2.0.1__py3-none-any.whl

js7/client/action/iam/reset_account_passwords_action.py

@@ -0,0 +1,75 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    AccountNamesFilter as AccountNamesFilter_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def reset_account_passwords_action(
+    *,
+    context: Context,
+    identity_service_name: str,
+    account_names: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            identity_service_name=identity_service_name,
+            account_names=account_names,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/accounts/resetpassword", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    identity_service_name: str,
+    account_names: List[str],
+    audit_log: Optional[AuditLog]
+) -> AccountNamesFilter_V_2_8_2:
+
+    # Validate: identity_service_name
+    if not identity_service_name:
+        raise ValueError("'identity_service_name' is required.")
+    
+    # Validate: account_name
+    if not account_names:
+        raise ValueError("At least one account name in 'account_names' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return AccountNamesFilter_V_2_8_2(
+        identity_service_name=identity_service_name,
+        account_names=account_names,
+        audit_log=res_audit_log
+    )

js7/client/action/iam/set_folder_permissions_action.py

@@ -0,0 +1,96 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.filter.element.folder import Folder
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    Folders as Folders_V_2_8_2,
+    Folder as Folder_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def set_folder_permissions_action(
+    *,
+    context: Context,
+    identity_service_name: str,
+    role_name: str,
+    controller_id: str,
+    folders: List[Folder],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            identity_service_name=identity_service_name,
+            role_name=role_name,
+            controller_id=controller_id,
+            folders=folders,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/folders/store", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    identity_service_name: str,
+    role_name: str,
+    controller_id: str,
+    folders: List[Folder],
+    audit_log: Optional[AuditLog]
+) -> Folders_V_2_8_2:
+
+    # Validate: identity_service_name
+    if not identity_service_name:
+        raise ValueError("'identity_service_name' is required.")
+    
+    # Validate: role_name
+    if not role_name:
+        raise ValueError("'role_name' is required.")
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: folders
+    if not folders:
+        raise ValueError("At least one folder in 'folders' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return Folders_V_2_8_2(
+        identity_service_name=identity_service_name,
+        role_name=role_name,
+        controller_id=controller_id,
+        folders=[
+            Folder_V_2_8_2(folder=f.folder_path, recursive=f.recursive)
+            for f in folders
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/iam/set_permissions_action.py

@@ -0,0 +1,91 @@
+from typing import List, Optional, Tuple
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    Permissions as Permissions_V_2_8_2,
+    Permission as Permission_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def set_permissions_action(
+    *,
+    context: Context,
+    identity_service_name: str,
+    role_name: str,
+    controller_id: str,
+    permissions: List[Tuple[str, bool]],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            identity_service_name=identity_service_name,
+            role_name=role_name,
+            controller_id=controller_id,
+            permissions=permissions,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/permissions/store", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    identity_service_name: str,
+    role_name: str,
+    controller_id: str,
+    permissions: List[Tuple[str, bool]],
+    audit_log: Optional[AuditLog]
+) -> Permissions_V_2_8_2:
+
+    # Validate: identity_service_name
+    if not identity_service_name:
+        raise ValueError("'identity_service_name' is required.")
+    
+    # Validate: role_name
+    if not role_name:
+        raise ValueError("'role_name' is required.")
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return Permissions_V_2_8_2(
+        identity_service_name=identity_service_name,
+        role_name=role_name,
+        controller_id=controller_id,
+        permissions=[
+            Permission_V_2_8_2(permission_path=p, excluded=e)
+            for p, e in permissions
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/iam/store_account_action.py

@@ -0,0 +1,69 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.accounts import Account
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    Account as Account_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_account_action(
+    *,
+    context: Context,
+    account: Account,
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            account=account,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/account/store", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    account: Account,
+    audit_log: Optional[AuditLog]
+) -> Account_V_2_8_2:
+
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return Account_V_2_8_2(
+        account_name=account.account_name,
+        password=account.password,
+        disabled=account.disabled,
+        force_password_change=account.force_password_change,
+        identity_service_name=account.identity_service_name,
+        roles=account.roles,
+        audit_log=res_audit_log
+    )

js7/client/action/iam/store_identity_service_action.py

@@ -0,0 +1,75 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.identity_service import IdentityService
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    IdentityService as IdentityService_V_2_8_2,
+    IdentityServiceType as IdentityServiceType_V_2_8_2,
+    ServiceAuthenticationScheme as ServiceAuthenticationScheme_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_identity_service_action(
+    *,
+    context: Context,
+    identity_service: IdentityService,
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            identity_service=identity_service,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/identityservice/store", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    identity_service: IdentityService,
+    audit_log: Optional[AuditLog]
+) -> IdentityService_V_2_8_2:
+
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return IdentityService_V_2_8_2(
+        identity_service_name=identity_service.identity_service_name,
+        # Raises ValueError() if invalid.
+        identity_service_type=IdentityServiceType_V_2_8_2(identity_service.identity_service_type), 
+        # Raises ValueError() if invalid.
+        service_authentication_scheme=ServiceAuthenticationScheme_V_2_8_2(identity_service.service_authentication_scheme),
+        second_factor=identity_service.second_factor,
+        second_factor_identity_service_name=identity_service.second_factor_identity_service_name,
+        disabled=identity_service.disabled,
+        required=identity_service.required,
+        ordering=identity_service.ordering,
+        audit_log=res_audit_log
+    )

js7/client/action/iam/store_identity_service_settings_action.py

@@ -0,0 +1,74 @@
+import json
+from typing import Any, Dict, Literal
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    Configuration as Configuration_V_2_8_2,
+    ConfigurationType as ConfigurationType_V_2_8_2,
+    ConfigurationOk as ConfigurationOk_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_identity_service_settings_action(
+    *,
+    context: Context,
+    identity_service_name: str,
+    identity_service_type: Literal["KEYCLOAK", "KEYCLOAK-JOC", "LDAP", "LDAP-JOC", "OIDC", "OIDC-JOC", "FIDO", "JOC", "CERTIFICATE"],
+    settings: Dict[str, Any]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            identity_service_name=identity_service_name,
+            identity_service_type=identity_service_type,
+            settings=settings
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="configuration/save", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, ConfigurationOk_V_2_8_2):
+        return bool(result.id)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    identity_service_name: str,
+    identity_service_type: Literal["KEYCLOAK", "KEYCLOAK-JOC", "LDAP", "LDAP-JOC", "OIDC", "OIDC-JOC", "FIDO", "JOC", "CERTIFICATE"],
+    settings: Dict[str, Any]
+) -> Configuration_V_2_8_2:
+    
+    # Validate: identity_service_name
+    if not identity_service_name:
+        raise ValueError("'identity_service_name' is required.")
+    
+    # Validate: identity_service_type
+    if identity_service_type not in ["KEYCLOAK", "KEYCLOAK-JOC", "LDAP", "LDAP-JOC", "OIDC", "OIDC-JOC", "FIDO", "JOC", "CERTIFICATE"]:
+        raise ValueError(f"identity service type: {identity_service_type} is not supported.")
+    
+    # Validate: settings
+    if not settings:
+        raise ValueError("'settings' is required.")
+    
+    # Result
+    return Configuration_V_2_8_2(
+        id=0,
+        name=identity_service_name,
+        object_type=identity_service_type,
+        configuration_type=ConfigurationType_V_2_8_2.IAM,
+        configuration_item=json.dumps(settings),
+    )

js7/client/action/iam/store_role_action.py

@@ -0,0 +1,79 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    RoleStore as RoleStore_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_role_action(
+    *, 
+    context: Context,
+    identity_service_name: str,
+    role_name: str,
+    ordering: Optional[int],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            identity_service_name=identity_service_name,
+            role_name=role_name,
+            ordering=ordering,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/role/store", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    identity_service_name: str,
+    role_name: str,
+    ordering: Optional[int],
+    audit_log: Optional[AuditLog]
+) -> RoleStore_V_2_8_2:
+
+    # Validate: identity_service_name
+    if not identity_service_name:
+        raise ValueError("'identity_service_name' is required.")
+    
+    # Validate: role_name
+    if not role_name:
+        raise ValueError("'role_name' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return RoleStore_V_2_8_2(
+        identity_service_name=identity_service_name,
+        role_name=role_name,
+        ordering=ordering,
+        audit_log=res_audit_log
+    )

js7/client/action/iam/unblock_accounts_action.py

@@ -0,0 +1,67 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    BlockedAccountsDeleteFilter as BlockedAccountsDeleteFilter_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def unblock_accounts_action(
+    *,
+    context: Context,
+    account_names: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            account_names=account_names,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="iam/blockedAccounts/delete", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    account_names: List[str],
+    audit_log: Optional[AuditLog]
+) -> BlockedAccountsDeleteFilter_V_2_8_2:
+
+    # Validate: account_names
+    if not account_names:
+        raise ValueError("At least one account name in 'account_names' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return BlockedAccountsDeleteFilter_V_2_8_2(
+        account_names=account_names,
+        audit_log=res_audit_log
+    )