js7-client-python 2.0.1__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.
- js7/__init__.py +8 -0
- js7/api/joc/http/v_2_8_2/agent/cluster/confirm_node_loss.py +36 -0
- js7/api/joc/http/v_2_8_2/agent/cluster/switchover.py +36 -0
- js7/api/joc/http/v_2_8_2/agent/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/agents.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/cluster/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/cluster/deploy.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/cluster/revoke.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/cluster/store.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/export.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/import.py +74 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/deploy.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/revoke.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/store.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/subagents/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/subagents/disable.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/subagents/enable.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/subagents/reset.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/cluster/subagents/store.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/deploy.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/disable.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/enable.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/revoke.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/inventory/store.py +36 -0
- js7/api/joc/http/v_2_8_2/agents/reset.py +36 -0
- js7/api/joc/http/v_2_8_2/authentication/auth.py +32 -0
- js7/api/joc/http/v_2_8_2/authentication/joc_cockpit_permissions.py +28 -0
- js7/api/joc/http/v_2_8_2/authentication/login.py +35 -0
- js7/api/joc/http/v_2_8_2/authentication/logout.py +28 -0
- js7/api/joc/http/v_2_8_2/configuration/configuration.py +36 -0
- js7/api/joc/http/v_2_8_2/configuration/save.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/abort.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/abort_and_restart.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/cluster/appoint_nodes.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/cluster/confirm_node_loss.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/cluster/switchover.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/components.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/controller.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/register.py +42 -0
- js7/api/joc/http/v_2_8_2/controller/restart.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/terminate.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/test.py +36 -0
- js7/api/joc/http/v_2_8_2/controller/unregister.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/cancel.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/copy.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/generate.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/modify.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/orders.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/orders/submit.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/projections/calendar.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/projections/dates.py +36 -0
- js7/api/joc/http/v_2_8_2/daily_plan/projections/recreate.py +28 -0
- js7/api/joc/http/v_2_8_2/daily_plan/submissions/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/account/change_password.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/account/permissions.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/account/rename.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/account/store.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/accounts/accounts.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/accounts/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/accounts/disable.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/accounts/enable.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/accounts/reset_password.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/blocked_account/store.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/blocked_accounts/blocked_accounts.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/blocked_accounts/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/folder/folder.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/folder/rename.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/folders/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/folders/folders.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/folders/store.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/identity_service/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/identity_service/identity_service.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/identity_service/rename.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/identity_service/store.py +42 -0
- js7/api/joc/http/v_2_8_2/iam/identity_services/identity_services.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/permission/permission.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/permission/rename.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/permissions/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/permissions/permissions.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/permissions/store.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/role/rename.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/role/role.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/role/store.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/roles/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/iam/roles/roles.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/changes/changes.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/dependencies.py +33 -0
- js7/api/joc/http/v_2_8_2/inventory/deployment/deploy.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/deployment/import_deploy.py +66 -0
- js7/api/joc/http/v_2_8_2/inventory/deployment/revoke.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/export/export.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/export/folder.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/import_objects.py +88 -0
- js7/api/joc/http/v_2_8_2/inventory/releasables/recall/folder.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/releasables/recall/recall.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/release.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/remove/folder.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/remove/remove.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/add.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/checkout.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/clone.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/commit.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/credentials/add.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/credentials/credentials.py +28 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/credentials/remove.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/pull.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/git/push.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/read.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/store.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/repository/update.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/revalidate/folder.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/store.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/trash/delete/delete.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/trash/delete/folder.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/trash/restore.py +36 -0
- js7/api/joc/http/v_2_8_2/inventory/validate.py +42 -0
- js7/api/joc/http/v_2_8_2/joc/cluster/restart.py +36 -0
- js7/api/joc/http/v_2_8_2/joc/cluster/run.py +36 -0
- js7/api/joc/http/v_2_8_2/joc/cluster/switch_member.py +36 -0
- js7/api/joc/http/v_2_8_2/joc/license.py +28 -0
- js7/api/joc/http/v_2_8_2/joc/proxies/restart.py +36 -0
- js7/api/joc/http/v_2_8_2/joc/version.py +28 -0
- js7/api/joc/http/v_2_8_2/joc/versions.py +36 -0
- js7/api/joc/http/v_2_8_2/orders/add.py +33 -0
- js7/api/joc/http/v_2_8_2/orders/cancel.py +33 -0
- js7/api/joc/http/v_2_8_2/orders/confirm.py +36 -0
- js7/api/joc/http/v_2_8_2/orders/continue.py +36 -0
- js7/api/joc/http/v_2_8_2/orders/history.py +36 -0
- js7/api/joc/http/v_2_8_2/orders/orders.py +36 -0
- js7/api/joc/http/v_2_8_2/orders/remove_when_terminated.py +33 -0
- js7/api/joc/http/v_2_8_2/orders/resume.py +36 -0
- js7/api/joc/http/v_2_8_2/orders/suspend.py +36 -0
- js7/api/joc/http/v_2_8_2/settings/settings.py +28 -0
- js7/api/joc/http/v_2_8_2/settings/store.py +36 -0
- js7/api/joc/http/v_2_8_2/tasks/history.py +36 -0
- js7/api/joc/http/v_2_8_2/workflow/transition.py +36 -0
- js7/api/joc/http/v_2_8_2/workflow/workflow.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/resume.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/skip.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/stop.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/suspend.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/unskip.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/unstop.py +36 -0
- js7/api/joc/http/v_2_8_2/workflows/workflows.py +36 -0
- js7/api/joc/interface/dispatcher.py +76 -0
- js7/api/joc/interface/interface.py +8 -0
- js7/api/joc/interface/resolver.py +75 -0
- js7/client/action/agent/confirm_node_loss_agent_action.py +75 -0
- js7/client/action/agent/delete_subagent_action.py +77 -0
- js7/client/action/agent/delete_subagent_clusters_action.py +75 -0
- js7/client/action/agent/deploy_cluster_agents_action.py +75 -0
- js7/client/action/agent/deploy_standalone_agents_action.py +75 -0
- js7/client/action/agent/deploy_subagent_clusters_action.py +75 -0
- js7/client/action/agent/disable_standalone_agents_action.py +75 -0
- js7/client/action/agent/disable_subagents_action.py +75 -0
- js7/client/action/agent/enable_standalone_agents_action.py +75 -0
- js7/client/action/agent/enable_subagents_action.py +75 -0
- js7/client/action/agent/export_agents_action.py +101 -0
- js7/client/action/agent/get_agents_status_action.py +55 -0
- js7/client/action/agent/import_agents_action.py +139 -0
- js7/client/action/agent/remove_agent_action.py +79 -0
- js7/client/action/agent/reset_agents_action.py +79 -0
- js7/client/action/agent/reset_subagent_action.py +79 -0
- js7/client/action/agent/revoke_cluster_agents_action.py +75 -0
- js7/client/action/agent/revoke_standalone_agents_action.py +75 -0
- js7/client/action/agent/revoke_subagent_clusters_action.py +75 -0
- js7/client/action/agent/store_cluster_agents_action.py +99 -0
- js7/client/action/agent/store_standalone_agents_action.py +87 -0
- js7/client/action/agent/store_subagent_clusters_action.py +83 -0
- js7/client/action/agent/store_subagents_action.py +97 -0
- js7/client/action/agent/switchover_agent_action.py +75 -0
- js7/client/action/controller/appoint_nodes_controller_action.py +67 -0
- js7/client/action/controller/cancel_and_restart_controller_action.py +72 -0
- js7/client/action/controller/cancel_controller_action.py +71 -0
- js7/client/action/controller/confirm_cluster_node_loss_action.py +68 -0
- js7/client/action/controller/get_controller_components_action.py +41 -0
- js7/client/action/controller/get_controller_status_action.py +72 -0
- js7/client/action/controller/register_controller_action.py +93 -0
- js7/client/action/controller/restart_controller_action.py +72 -0
- js7/client/action/controller/switchover_controller_cluster_action.py +67 -0
- js7/client/action/controller/terminate_controller_action.py +72 -0
- js7/client/action/controller/test_controller_instance_action.py +65 -0
- js7/client/action/controller/unregister_controller_action.py +68 -0
- js7/client/action/daily_plan/cancel_orders_action.py +59 -0
- js7/client/action/daily_plan/copy_orders_action.py +108 -0
- js7/client/action/daily_plan/create_projections_action.py +24 -0
- js7/client/action/daily_plan/delete_orders_action.py +80 -0
- js7/client/action/daily_plan/delete_submissions_action.py +83 -0
- js7/client/action/daily_plan/generate_orders_action.py +121 -0
- js7/client/action/daily_plan/get_calendar_projections_action.py +59 -0
- js7/client/action/daily_plan/get_orders_action.py +70 -0
- js7/client/action/daily_plan/get_projection_dates_action.py +59 -0
- js7/client/action/daily_plan/modify_orders_action.py +130 -0
- js7/client/action/daily_plan/submit_orders_action.py +79 -0
- js7/client/action/helper/decrypt_action.py +82 -0
- js7/client/action/helper/encrypt_action.py +87 -0
- js7/client/action/iam/block_account_action.py +71 -0
- js7/client/action/iam/change_account_password_action.py +96 -0
- js7/client/action/iam/disable_accounts_action.py +75 -0
- js7/client/action/iam/enable_accounts_action.py +75 -0
- js7/client/action/iam/get_account_permissions_action.py +75 -0
- js7/client/action/iam/get_accounts_action.py +76 -0
- js7/client/action/iam/get_blocked_accounts_action.py +76 -0
- js7/client/action/iam/get_folder_permissions_action.py +112 -0
- js7/client/action/iam/get_identity_service_settings_action.py +70 -0
- js7/client/action/iam/get_identity_services_action.py +102 -0
- js7/client/action/iam/get_permissions_action.py +113 -0
- js7/client/action/iam/get_roles_action.py +57 -0
- js7/client/action/iam/remove_accounts_action.py +75 -0
- js7/client/action/iam/remove_folder_permissions_action.py +91 -0
- js7/client/action/iam/remove_identity_service_action.py +67 -0
- js7/client/action/iam/remove_permissions_action.py +88 -0
- js7/client/action/iam/remove_roles_action.py +75 -0
- js7/client/action/iam/rename_account_action.py +83 -0
- js7/client/action/iam/rename_folder_permissions_action.py +100 -0
- js7/client/action/iam/rename_identity_service_action.py +75 -0
- js7/client/action/iam/rename_permission_action.py +103 -0
- js7/client/action/iam/rename_role_action.py +83 -0
- js7/client/action/iam/reset_account_passwords_action.py +75 -0
- js7/client/action/iam/set_folder_permissions_action.py +96 -0
- js7/client/action/iam/set_permissions_action.py +91 -0
- js7/client/action/iam/store_account_action.py +69 -0
- js7/client/action/iam/store_identity_service_action.py +75 -0
- js7/client/action/iam/store_identity_service_settings_action.py +74 -0
- js7/client/action/iam/store_role_action.py +79 -0
- js7/client/action/iam/unblock_accounts_action.py +67 -0
- js7/client/action/inventory/deploy_configurations_action.py +138 -0
- js7/client/action/inventory/export_configurations_action.py +203 -0
- js7/client/action/inventory/export_folders_action.py +160 -0
- js7/client/action/inventory/get_change_dependencies_action.py +161 -0
- js7/client/action/inventory/get_changes_action.py +59 -0
- js7/client/action/inventory/get_git_credentials_action.py +29 -0
- js7/client/action/inventory/git_add_action.py +72 -0
- js7/client/action/inventory/git_checkout_action.py +88 -0
- js7/client/action/inventory/git_clone_action.py +84 -0
- js7/client/action/inventory/git_commit_action.py +80 -0
- js7/client/action/inventory/git_pull_action.py +72 -0
- js7/client/action/inventory/git_push_action.py +76 -0
- js7/client/action/inventory/import_configurations_action.py +153 -0
- js7/client/action/inventory/import_deploy_configurations_action.py +188 -0
- js7/client/action/inventory/read_from_local_repository_action.py +67 -0
- js7/client/action/inventory/recall_folder_action.py +89 -0
- js7/client/action/inventory/recall_released_configuration_action.py +75 -0
- js7/client/action/inventory/release_configuartions_action.py +89 -0
- js7/client/action/inventory/remove_configurations_action.py +77 -0
- js7/client/action/inventory/remove_configurations_from_trash_action.py +80 -0
- js7/client/action/inventory/remove_folder_action.py +67 -0
- js7/client/action/inventory/remove_folder_from_trash_action.py +69 -0
- js7/client/action/inventory/remove_git_credentials_action.py +53 -0
- js7/client/action/inventory/remove_repository_configuration_action.py +84 -0
- js7/client/action/inventory/restore_configuration_from_trash_action.py +84 -0
- js7/client/action/inventory/revalidate_folder_action.py +46 -0
- js7/client/action/inventory/revoke_configurations_action.py +86 -0
- js7/client/action/inventory/store_configuration_action.py +79 -0
- js7/client/action/inventory/store_git_credentials_action.py +99 -0
- js7/client/action/inventory/store_repository_configuration_action.py +124 -0
- js7/client/action/inventory/update_repository_configuration_action.py +85 -0
- js7/client/action/inventory/validate_configuration_action.py +58 -0
- js7/client/action/joc/get_components_versions_action.py +57 -0
- js7/client/action/joc/get_license_info_action.py +22 -0
- js7/client/action/joc/get_settings_action.py +19 -0
- js7/client/action/joc/get_version_action.py +17 -0
- js7/client/action/joc/restart_proxies_action.py +50 -0
- js7/client/action/joc/restart_service_action.py +74 -0
- js7/client/action/joc/run_service_action.py +74 -0
- js7/client/action/joc/store_settings_action.py +62 -0
- js7/client/action/joc/switch_over_action.py +89 -0
- js7/client/action/order/add_orders_action.py +115 -0
- js7/client/action/order/cancel_orders_action.py +93 -0
- js7/client/action/order/confirm_orders_action.py +86 -0
- js7/client/action/order/continue_orders_action.py +86 -0
- js7/client/action/order/get_order_history_action.py +84 -0
- js7/client/action/order/get_orders_action.py +83 -0
- js7/client/action/order/remove_terminated_orders_action.py +86 -0
- js7/client/action/order/resume_orders_action.py +102 -0
- js7/client/action/order/suspend_orders_action.py +97 -0
- js7/client/action/task/get_task_history_info_action.py +88 -0
- js7/client/action/workflow/get_workflow_versions_action.py +131 -0
- js7/client/action/workflow/resume_workflows_action.py +76 -0
- js7/client/action/workflow/set_workflow_version_as_current_action.py +86 -0
- js7/client/action/workflow/skip_job_instructions_action.py +83 -0
- js7/client/action/workflow/stop_job_instructions_action.py +83 -0
- js7/client/action/workflow/suspend_workflows_action.py +76 -0
- js7/client/action/workflow/unskip_job_instructions_action.py +83 -0
- js7/client/action/workflow/unstop_job_instructions_action.py +79 -0
- js7/client/auth/auth_provider.py +109 -0
- js7/client/auth/login.py +34 -0
- js7/client/auth/logout.py +22 -0
- js7/client/client.py +250 -0
- js7/client/context.py +40 -0
- js7/client/feature/agent/agent.py +26 -0
- js7/client/feature/agent/deploy.py +134 -0
- js7/client/feature/agent/manage.py +363 -0
- js7/client/feature/agent/operate.py +577 -0
- js7/client/feature/controller/controller.py +19 -0
- js7/client/feature/controller/manage.py +214 -0
- js7/client/feature/controller/operate.py +274 -0
- js7/client/feature/daily_plan/daily_plan.py +14 -0
- js7/client/feature/daily_plan/manage.py +179 -0
- js7/client/feature/daily_plan/operate.py +354 -0
- js7/client/feature/iam/iam.py +14 -0
- js7/client/feature/iam/manage.py +1311 -0
- js7/client/feature/inventory/inventory.py +13 -0
- js7/client/feature/inventory/manage.py +943 -0
- js7/client/feature/inventory/manage_repository.py +533 -0
- js7/client/feature/joc/joc.py +18 -0
- js7/client/feature/joc/manage.py +102 -0
- js7/client/feature/joc/operate.py +185 -0
- js7/client/feature/order/manage.py +79 -0
- js7/client/feature/order/operate.py +346 -0
- js7/client/feature/order/order.py +18 -0
- js7/client/feature/task/task.py +54 -0
- js7/client/feature/workflow/manage.py +54 -0
- js7/client/feature/workflow/operate.py +336 -0
- js7/client/feature/workflow/workflow.py +19 -0
- js7/java/lib/3rd-party/bcpg-jdk15to18-1.78.1.jar +0 -0
- js7/java/lib/3rd-party/bcpkix-jdk15to18-1.78.1.jar +0 -0
- js7/java/lib/3rd-party/bcprov-jdk15to18-1.78.1.jar +0 -0
- js7/java/lib/3rd-party/bcutil-jdk15to18-1.78.1.jar +0 -0
- js7/java/lib/3rd-party/commons-io-2.15.1.jar +0 -0
- js7/java/lib/3rd-party/commons-lang3-3.14.0.jar +0 -0
- js7/java/lib/3rd-party/jackson-core-2.14.2.jar +0 -0
- js7/java/lib/3rd-party/jackson-databind-2.14.2.jar +0 -0
- js7/java/lib/3rd-party/jackson-dataformat-xml-2.14.2.jar +0 -0
- js7/java/lib/3rd-party/jakarta.annotation-api-2.1.1.jar +0 -0
- js7/java/lib/3rd-party/javax.activation-api-1.2.0.jar +0 -0
- js7/java/lib/3rd-party/jaxb-api-2.4.0-b180830.0359.jar +0 -0
- js7/java/lib/3rd-party/org.apache.logging.log4j.log4j-api-2.23.1.jar +0 -0
- js7/java/lib/3rd-party/org.apache.logging.log4j.log4j-core-2.23.1.jar +0 -0
- js7/java/lib/3rd-party/org.apache.logging.log4j.log4j-slf4j2-impl-2.23.1.jar +0 -0
- js7/java/lib/3rd-party/org.slf4j.slf4j-api-2.0.13.jar +0 -0
- js7/java/lib/3rd-party/stax2-api-4.2.1.jar +0 -0
- js7/java/lib/3rd-party/woodstox-core-6.5.0.jar +0 -0
- js7/java/lib/sos/sos-commons-encryption-2.7.3.jar +0 -0
- js7/java/lib/sos/sos-commons-exception-2.7.3.jar +0 -0
- js7/java/lib/sos/sos-commons-sign-2.7.3.jar +0 -0
- js7/java/lib/sos/sos-webservices-json-2.7.3.jar +0 -0
- js7/model/__init__.py +132 -0
- js7/model/configuration/auth_configuration.py +24 -0
- js7/model/configuration/client_configuration.py +6 -0
- js7/model/configuration/http_configuration.py +10 -0
- js7/model/error/http/joc_exceptions.py +151 -0
- js7/model/private/api/endpoint.py +30 -0
- js7/model/private/http/joc/joc_v_2_8_2.py +3666 -0
- js7/model/public/client/common/__init__.py +27 -0
- js7/model/public/client/common/accounts.py +21 -0
- js7/model/public/client/common/audit_log.py +8 -0
- js7/model/public/client/common/changes.py +18 -0
- js7/model/public/client/common/configurations.py +53 -0
- js7/model/public/client/common/cycle.py +12 -0
- js7/model/public/client/common/git_credentials.py +12 -0
- js7/model/public/client/common/identity_service.py +14 -0
- js7/model/public/client/common/schedule_time.py +50 -0
- js7/model/public/client/common/store_agents.py +96 -0
- js7/model/public/client/enum/__init__.py +19 -0
- js7/model/public/client/enum/object_types.py +48 -0
- js7/model/public/client/enum/operation_type.py +11 -0
- js7/model/public/client/enum/order_priority.py +9 -0
- js7/model/public/client/filter/__init__.py +35 -0
- js7/model/public/client/filter/daily_plan_order_filters.py +255 -0
- js7/model/public/client/filter/element/__init__.py +3 -0
- js7/model/public/client/filter/element/folder.py +6 -0
- js7/model/public/client/filter/element/workflow_id.py +10 -0
- js7/model/public/client/filter/export_filter.py +52 -0
- js7/model/public/client/filter/export_folders_filter.py +34 -0
- js7/model/public/client/filter/get_order_filter.py +59 -0
- js7/model/public/client/filter/order_history_filter.py +113 -0
- js7/model/public/client/filter/resume_order_filter.py +45 -0
- js7/model/public/client/filter/suspend_order_filter.py +44 -0
- js7/model/public/client/filter/tasks_filter.py +50 -0
- js7/model/public/client/input/__init__.py +2 -0
- js7/model/public/client/input/add_order.py +50 -0
- js7/service/http_service.py +206 -0
- js7/util/bytes_converter/bytes_to_archive_bytes.py +52 -0
- js7/util/bytes_converter/bytes_to_file.py +12 -0
- js7/util/bytes_converter/files_to_bytes.py +52 -0
- js7/util/bytes_converter/read_bytes_archive_files_to_bytes.py +69 -0
- js7/util/bytes_converter/sign_to_bytes.py +106 -0
- js7/util/check_matching_version.py +20 -0
- js7/util/detect_archive_type.py +37 -0
- js7/util/str_converter/order_id_to_order_name.py +5 -0
- js7/validator/http/joc_http_status_validator.py +155 -0
- js7_client_python-2.0.1.0.dist-info/LICENSE +674 -0
- js7_client_python-2.0.1.0.dist-info/METADATA +763 -0
- js7_client_python-2.0.1.0.dist-info/RECORD +389 -0
- js7_client_python-2.0.1.0.dist-info/WHEEL +5 -0
- js7_client_python-2.0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1311 @@
|
|
|
1
|
+
from datetime import datetime
|
|
2
|
+
from typing import Any, Dict, List, Literal, Optional, Tuple
|
|
3
|
+
|
|
4
|
+
from ....client.context import Context
|
|
5
|
+
from ....model.public.client.common.identity_service import IdentityService
|
|
6
|
+
from ....model.public.client.filter.element.folder import Folder
|
|
7
|
+
from ....model.public.client.common.audit_log import AuditLog
|
|
8
|
+
from ....model.public.client.common.accounts import Account, BlockedAccount
|
|
9
|
+
|
|
10
|
+
from ...action.iam.get_accounts_action import get_accounts_action
|
|
11
|
+
from ...action.iam.store_account_action import store_account_action
|
|
12
|
+
from ...action.iam.get_blocked_accounts_action import get_blocked_accounts_action
|
|
13
|
+
from ...action.iam.rename_account_action import rename_account_action
|
|
14
|
+
from ...action.iam.remove_accounts_action import remove_accounts_action
|
|
15
|
+
from ...action.iam.get_account_permissions_action import get_account_permissions_action
|
|
16
|
+
from ...action.iam.change_account_password_action import change_account_password_action
|
|
17
|
+
from ...action.iam.reset_account_passwords_action import reset_account_passwords_action
|
|
18
|
+
from ...action.iam.enable_accounts_action import enable_accounts_action
|
|
19
|
+
from ...action.iam.disable_accounts_action import disable_accounts_action
|
|
20
|
+
from ...action.iam.block_account_action import block_account_action
|
|
21
|
+
from ...action.iam.unblock_accounts_action import unblock_accounts_action
|
|
22
|
+
from ...action.iam.get_roles_action import get_roles_action
|
|
23
|
+
from ...action.iam.store_role_action import store_role_action
|
|
24
|
+
from ...action.iam.rename_role_action import rename_role_action
|
|
25
|
+
from ...action.iam.remove_roles_action import remove_roles_action
|
|
26
|
+
from ...action.iam.get_permissions_action import get_permissions_action
|
|
27
|
+
from ...action.iam.set_permissions_action import set_permissions_action
|
|
28
|
+
from ...action.iam.rename_permission_action import rename_permission_action
|
|
29
|
+
from ...action.iam.remove_permissions_action import remove_permissions_action
|
|
30
|
+
from ...action.iam.get_folder_permissions_action import get_folder_permissions_action
|
|
31
|
+
from ...action.iam.set_folder_permissions_action import set_folder_permissions_action
|
|
32
|
+
from ...action.iam.rename_folder_permissions_action import rename_folder_permissions_action
|
|
33
|
+
from ...action.iam.remove_folder_permissions_action import remove_folder_permissions_action
|
|
34
|
+
from ...action.iam.get_identity_services_action import get_identity_services_action
|
|
35
|
+
from ...action.iam.store_identity_service_action import store_identity_service_action
|
|
36
|
+
from ...action.iam.rename_identity_service_action import rename_identity_service_action
|
|
37
|
+
from ...action.iam.remove_identity_service_action import remove_identity_service_action
|
|
38
|
+
from ...action.iam.get_identity_service_settings_action import get_identity_service_settings_action
|
|
39
|
+
from ...action.iam.store_identity_service_settings_action import store_identity_service_settings_action
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
class Manage:
|
|
43
|
+
def __init__(self, context: Context):
|
|
44
|
+
self._ctx = context
|
|
45
|
+
|
|
46
|
+
def get_accounts(
|
|
47
|
+
self,
|
|
48
|
+
identity_service_name: str,
|
|
49
|
+
filter_account_name: Optional[str] = None,
|
|
50
|
+
filter_enabled: bool = False,
|
|
51
|
+
filter_disabled: bool = False
|
|
52
|
+
) -> List[Account]:
|
|
53
|
+
"""
|
|
54
|
+
Returns a collection of Accounts.
|
|
55
|
+
|
|
56
|
+
Args:
|
|
57
|
+
identity_service_name (str):
|
|
58
|
+
The name of the Identity Service to be used for this operation.
|
|
59
|
+
|
|
60
|
+
filter_account_name (str):
|
|
61
|
+
Retrieve the account with this name.
|
|
62
|
+
|
|
63
|
+
filter_enabled (bool):
|
|
64
|
+
If `True` retrieve only enabled accounts.
|
|
65
|
+
|
|
66
|
+
filter_disabled (bool):
|
|
67
|
+
If `True` retrieve only disabled accounts.
|
|
68
|
+
|
|
69
|
+
Returns:
|
|
70
|
+
List[Account]: Returns a collection of Accounts.
|
|
71
|
+
|
|
72
|
+
Raises:
|
|
73
|
+
ValueError:
|
|
74
|
+
If required arguments are missing or invalid.
|
|
75
|
+
|
|
76
|
+
RuntimeError:
|
|
77
|
+
If the server version is not compatible or if an
|
|
78
|
+
unexpected response is returned.
|
|
79
|
+
"""
|
|
80
|
+
|
|
81
|
+
return get_accounts_action(
|
|
82
|
+
context=self._ctx,
|
|
83
|
+
identity_service_name=identity_service_name,
|
|
84
|
+
filter_account_name=filter_account_name,
|
|
85
|
+
filter_enabled=filter_enabled,
|
|
86
|
+
filter_disabled=filter_disabled
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
def get_blocked_accounts(
|
|
90
|
+
self,
|
|
91
|
+
filter_date_from: Optional[datetime] = None,
|
|
92
|
+
filter_date_to: Optional[datetime] = None,
|
|
93
|
+
filter_account_name: Optional[str] = None
|
|
94
|
+
) -> List[BlockedAccount]:
|
|
95
|
+
"""
|
|
96
|
+
Returns a collection of blocked accounts.
|
|
97
|
+
|
|
98
|
+
Args:
|
|
99
|
+
filter_date_from (Optional[datetime]):
|
|
100
|
+
Filters blocked accounts starting from the specified date.
|
|
101
|
+
|
|
102
|
+
filter_date_to (Optional[datetime]):
|
|
103
|
+
Filters blocked accounts up to the specified date.
|
|
104
|
+
|
|
105
|
+
filter_account_name (Optional[str]):
|
|
106
|
+
If provided, filters the results by the specified account name.
|
|
107
|
+
|
|
108
|
+
Returns:
|
|
109
|
+
List[BlockedAccount]:
|
|
110
|
+
A list of blocked accounts matching the given filter criteria.
|
|
111
|
+
|
|
112
|
+
Raises:
|
|
113
|
+
RuntimeError:
|
|
114
|
+
If the server version is not compatible or if an
|
|
115
|
+
unexpected response is returned.
|
|
116
|
+
"""
|
|
117
|
+
|
|
118
|
+
return get_blocked_accounts_action(
|
|
119
|
+
context=self._ctx,
|
|
120
|
+
filter_date_from=filter_date_from,
|
|
121
|
+
filter_date_to=filter_date_to,
|
|
122
|
+
filter_account_name=filter_account_name
|
|
123
|
+
)
|
|
124
|
+
|
|
125
|
+
def store_account(
|
|
126
|
+
self,
|
|
127
|
+
account: Account,
|
|
128
|
+
audit_log: Optional[AuditLog] = None
|
|
129
|
+
) -> bool:
|
|
130
|
+
"""
|
|
131
|
+
Stores an account in the Identity Service.
|
|
132
|
+
|
|
133
|
+
Args:
|
|
134
|
+
account (Account):
|
|
135
|
+
The account to be created or stored in the Identity Service.
|
|
136
|
+
|
|
137
|
+
audit_log (Optional[AuditLog]):
|
|
138
|
+
Optional audit log information to be included with the request.
|
|
139
|
+
|
|
140
|
+
Returns:
|
|
141
|
+
bool:
|
|
142
|
+
Returns `True` if the operation was successful.
|
|
143
|
+
|
|
144
|
+
Raises:
|
|
145
|
+
ValueError:
|
|
146
|
+
If required arguments are missing or invalid.
|
|
147
|
+
|
|
148
|
+
RuntimeError:
|
|
149
|
+
If the server version is not compatible or if an
|
|
150
|
+
unexpected response is returned.
|
|
151
|
+
"""
|
|
152
|
+
|
|
153
|
+
return store_account_action(
|
|
154
|
+
context=self._ctx,
|
|
155
|
+
account=account,
|
|
156
|
+
audit_log=audit_log
|
|
157
|
+
)
|
|
158
|
+
|
|
159
|
+
def rename_account(
|
|
160
|
+
self,
|
|
161
|
+
identity_service_name: str,
|
|
162
|
+
account_name: str,
|
|
163
|
+
new_account_name: str,
|
|
164
|
+
audit_log: Optional[AuditLog] = None
|
|
165
|
+
) -> bool:
|
|
166
|
+
"""
|
|
167
|
+
Renames an account.
|
|
168
|
+
|
|
169
|
+
Args:
|
|
170
|
+
identity_service_name (str):
|
|
171
|
+
The name of the Identity Service to be used for this operation.
|
|
172
|
+
|
|
173
|
+
account_name (str):
|
|
174
|
+
The old name of the accoun.
|
|
175
|
+
|
|
176
|
+
new_account_name (str):
|
|
177
|
+
The new name of the account.
|
|
178
|
+
|
|
179
|
+
audit_log (Optional[AuditLog]):
|
|
180
|
+
Optional audit log information to be included with the request.
|
|
181
|
+
|
|
182
|
+
Returns:
|
|
183
|
+
bool:
|
|
184
|
+
Returns `True` if the operation was successful.
|
|
185
|
+
|
|
186
|
+
Raises:
|
|
187
|
+
ValueError:
|
|
188
|
+
If required arguments are missing or invalid.
|
|
189
|
+
|
|
190
|
+
RuntimeError:
|
|
191
|
+
If the server version is not compatible or if an
|
|
192
|
+
unexpected response is returned.
|
|
193
|
+
"""
|
|
194
|
+
|
|
195
|
+
return rename_account_action(
|
|
196
|
+
context=self._ctx,
|
|
197
|
+
identity_service_name=identity_service_name,
|
|
198
|
+
account_name=account_name,
|
|
199
|
+
new_account_name=new_account_name,
|
|
200
|
+
audit_log=audit_log
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
def remove_accounts(
|
|
204
|
+
self,
|
|
205
|
+
identity_service_name: str,
|
|
206
|
+
account_names: List[str],
|
|
207
|
+
audit_log: Optional[AuditLog] = None
|
|
208
|
+
) -> bool:
|
|
209
|
+
"""
|
|
210
|
+
Deletes accounts from an Identity Service.
|
|
211
|
+
|
|
212
|
+
Args:
|
|
213
|
+
identity_service_name (str):
|
|
214
|
+
The name of the Identity Service to be used for this operation.
|
|
215
|
+
|
|
216
|
+
account_names (List[str]):
|
|
217
|
+
A list of account names to be removed.
|
|
218
|
+
|
|
219
|
+
audit_log (Optional[AuditLog]):
|
|
220
|
+
Optional audit log information to be included with the request.
|
|
221
|
+
|
|
222
|
+
Returns:
|
|
223
|
+
bool:
|
|
224
|
+
Returns `True` if the operation was successful.
|
|
225
|
+
|
|
226
|
+
Raises:
|
|
227
|
+
ValueError:
|
|
228
|
+
If required arguments are missing or invalid.
|
|
229
|
+
|
|
230
|
+
RuntimeError:
|
|
231
|
+
If the server version is not compatible or if an
|
|
232
|
+
unexpected response is returned.
|
|
233
|
+
"""
|
|
234
|
+
|
|
235
|
+
return remove_accounts_action(
|
|
236
|
+
context=self._ctx,
|
|
237
|
+
identity_service_name=identity_service_name,
|
|
238
|
+
account_names=account_names,
|
|
239
|
+
audit_log=audit_log
|
|
240
|
+
)
|
|
241
|
+
|
|
242
|
+
def get_account_permissions(
|
|
243
|
+
self,
|
|
244
|
+
identity_service_name: str,
|
|
245
|
+
account_name: str,
|
|
246
|
+
audit_log: Optional[AuditLog] = None
|
|
247
|
+
) -> Dict[str, Any]:
|
|
248
|
+
"""
|
|
249
|
+
Returns the permissions for the specified account as they would apply
|
|
250
|
+
when logging in with that account.
|
|
251
|
+
|
|
252
|
+
Args:
|
|
253
|
+
identity_service_name (str):
|
|
254
|
+
The name of the Identity Service to be used for this operation.
|
|
255
|
+
|
|
256
|
+
account_name (str):
|
|
257
|
+
The name of the account for which permissions are requested.
|
|
258
|
+
|
|
259
|
+
audit_log (Optional[AuditLog]):
|
|
260
|
+
Optional audit log information to be included with the request.
|
|
261
|
+
|
|
262
|
+
Returns:
|
|
263
|
+
Dict ([str, Any]):
|
|
264
|
+
A dictionary containing the JSON representation of the
|
|
265
|
+
permissions for the specified account.
|
|
266
|
+
|
|
267
|
+
Raises:
|
|
268
|
+
ValueError:
|
|
269
|
+
If required arguments are missing or invalid.
|
|
270
|
+
|
|
271
|
+
RuntimeError:
|
|
272
|
+
If the server version is not compatible or if an
|
|
273
|
+
unexpected response is returned.
|
|
274
|
+
"""
|
|
275
|
+
|
|
276
|
+
return get_account_permissions_action(
|
|
277
|
+
context=self._ctx,
|
|
278
|
+
identity_service_name=identity_service_name,
|
|
279
|
+
account_name=account_name,
|
|
280
|
+
audit_log=audit_log
|
|
281
|
+
)
|
|
282
|
+
|
|
283
|
+
def change_account_password(
|
|
284
|
+
self,
|
|
285
|
+
identity_service_name: str,
|
|
286
|
+
account_name: str,
|
|
287
|
+
account_password: str,
|
|
288
|
+
new_account_password: str,
|
|
289
|
+
force_password_change: bool = False,
|
|
290
|
+
audit_log: Optional[AuditLog] = None
|
|
291
|
+
) -> bool:
|
|
292
|
+
"""
|
|
293
|
+
Changes the password for the specified account.
|
|
294
|
+
|
|
295
|
+
Args:
|
|
296
|
+
identity_service_name (str):
|
|
297
|
+
The name of the Identity Service to be used for this operation.
|
|
298
|
+
|
|
299
|
+
account_name (str):
|
|
300
|
+
The name of the account whose password is to be changed.
|
|
301
|
+
|
|
302
|
+
account_password (str):
|
|
303
|
+
The current password of the account.
|
|
304
|
+
|
|
305
|
+
new_account_password (str):
|
|
306
|
+
The new password to be set for the account.
|
|
307
|
+
|
|
308
|
+
force_password_change (bool):
|
|
309
|
+
If `True`, the account will be required to change the password
|
|
310
|
+
upon the next login.
|
|
311
|
+
|
|
312
|
+
audit_log (Optional[AuditLog]):
|
|
313
|
+
Optional audit log information to be included with the request.
|
|
314
|
+
|
|
315
|
+
Returns:
|
|
316
|
+
bool:
|
|
317
|
+
Returns `True` if the operation was successful.
|
|
318
|
+
|
|
319
|
+
Raises:
|
|
320
|
+
ValueError:
|
|
321
|
+
If required arguments are missing or invalid.
|
|
322
|
+
|
|
323
|
+
RuntimeError:
|
|
324
|
+
If the server version is not compatible or if an
|
|
325
|
+
unexpected response is returned.
|
|
326
|
+
"""
|
|
327
|
+
|
|
328
|
+
return change_account_password_action(
|
|
329
|
+
context=self._ctx,
|
|
330
|
+
identity_service_name=identity_service_name,
|
|
331
|
+
account_name=account_name,
|
|
332
|
+
account_password=account_password,
|
|
333
|
+
new_account_password=new_account_password,
|
|
334
|
+
force_password_change=force_password_change,
|
|
335
|
+
audit_log=audit_log
|
|
336
|
+
)
|
|
337
|
+
|
|
338
|
+
def reset_account_passwords(
|
|
339
|
+
self,
|
|
340
|
+
identity_service_name: str,
|
|
341
|
+
account_names: List[str],
|
|
342
|
+
audit_log: Optional[AuditLog] = None
|
|
343
|
+
) -> bool:
|
|
344
|
+
"""
|
|
345
|
+
Resets the specified account to its initial password.
|
|
346
|
+
|
|
347
|
+
Args:
|
|
348
|
+
identity_service_name (str):
|
|
349
|
+
The name of the Identity Service to be used for this operation.
|
|
350
|
+
|
|
351
|
+
account_name (str):
|
|
352
|
+
The name of the account whose password is to be reset
|
|
353
|
+
to the initial value.
|
|
354
|
+
|
|
355
|
+
audit_log (Optional[AuditLog]):
|
|
356
|
+
Optional audit log information to be included with the request.
|
|
357
|
+
|
|
358
|
+
Returns:
|
|
359
|
+
bool:
|
|
360
|
+
Returns `True` if the operation was successful.
|
|
361
|
+
|
|
362
|
+
Raises:
|
|
363
|
+
ValueError:
|
|
364
|
+
If required arguments are missing or invalid.
|
|
365
|
+
|
|
366
|
+
RuntimeError:
|
|
367
|
+
If the server version is not compatible or if an
|
|
368
|
+
unexpected response is returned.
|
|
369
|
+
"""
|
|
370
|
+
|
|
371
|
+
return reset_account_passwords_action(
|
|
372
|
+
context=self._ctx,
|
|
373
|
+
identity_service_name=identity_service_name,
|
|
374
|
+
account_names=account_names,
|
|
375
|
+
audit_log=audit_log
|
|
376
|
+
)
|
|
377
|
+
|
|
378
|
+
def enable_accounts(
|
|
379
|
+
self,
|
|
380
|
+
identity_service_name: str,
|
|
381
|
+
account_names: List[str],
|
|
382
|
+
audit_log: Optional[AuditLog] = None
|
|
383
|
+
) -> bool:
|
|
384
|
+
"""
|
|
385
|
+
Enables the specified accounts.
|
|
386
|
+
|
|
387
|
+
Args:
|
|
388
|
+
identity_service_name (str):
|
|
389
|
+
The name of the Identity Service to be used for this operation.
|
|
390
|
+
|
|
391
|
+
account_names (List[str]):
|
|
392
|
+
A list of account names to be enabled.
|
|
393
|
+
|
|
394
|
+
audit_log (Optional[AuditLog]):
|
|
395
|
+
Optional audit log information to be included with the request.
|
|
396
|
+
|
|
397
|
+
Returns:
|
|
398
|
+
bool:
|
|
399
|
+
Returns `True` if the operation was successful.
|
|
400
|
+
|
|
401
|
+
Raises:
|
|
402
|
+
ValueError:
|
|
403
|
+
If required arguments are missing or invalid.
|
|
404
|
+
|
|
405
|
+
RuntimeError:
|
|
406
|
+
If the server version is not compatible or if an
|
|
407
|
+
unexpected response is returned.
|
|
408
|
+
"""
|
|
409
|
+
|
|
410
|
+
return enable_accounts_action(
|
|
411
|
+
context=self._ctx,
|
|
412
|
+
identity_service_name=identity_service_name,
|
|
413
|
+
account_names=account_names,
|
|
414
|
+
audit_log=audit_log
|
|
415
|
+
)
|
|
416
|
+
|
|
417
|
+
def disable_accounts(
|
|
418
|
+
self,
|
|
419
|
+
identity_service_name: str,
|
|
420
|
+
account_names: List[str],
|
|
421
|
+
audit_log: Optional[AuditLog] = None
|
|
422
|
+
) -> bool:
|
|
423
|
+
"""
|
|
424
|
+
Disables the specified accounts.
|
|
425
|
+
|
|
426
|
+
Args:
|
|
427
|
+
identity_service_name (str):
|
|
428
|
+
The name of the Identity Service to be used for this operation.
|
|
429
|
+
|
|
430
|
+
account_names (List[str]):
|
|
431
|
+
A list of account names to be disabled.
|
|
432
|
+
|
|
433
|
+
audit_log (Optional[AuditLog]):
|
|
434
|
+
Optional audit log information to be included with the request.
|
|
435
|
+
|
|
436
|
+
Returns:
|
|
437
|
+
bool:
|
|
438
|
+
Returns `True` if the operation was successful.
|
|
439
|
+
|
|
440
|
+
Raises:
|
|
441
|
+
ValueError:
|
|
442
|
+
If required arguments are missing or invalid.
|
|
443
|
+
|
|
444
|
+
RuntimeError:
|
|
445
|
+
If the server version is not compatible or if an
|
|
446
|
+
unexpected response is returned.
|
|
447
|
+
"""
|
|
448
|
+
|
|
449
|
+
return disable_accounts_action(
|
|
450
|
+
context=self._ctx,
|
|
451
|
+
identity_service_name=identity_service_name,
|
|
452
|
+
account_names=account_names,
|
|
453
|
+
audit_log=audit_log
|
|
454
|
+
)
|
|
455
|
+
|
|
456
|
+
def block_account(
|
|
457
|
+
self,
|
|
458
|
+
account_name: str,
|
|
459
|
+
comment: Optional[str] = None,
|
|
460
|
+
audit_log: Optional[AuditLog] = None
|
|
461
|
+
) -> bool:
|
|
462
|
+
"""
|
|
463
|
+
Blocks the specified account.
|
|
464
|
+
|
|
465
|
+
Args:
|
|
466
|
+
account_name (str):
|
|
467
|
+
The name of the account to be blocked.
|
|
468
|
+
|
|
469
|
+
comment (str):
|
|
470
|
+
A comment to be associated with the blocked account,
|
|
471
|
+
typically describing the reason for the action.
|
|
472
|
+
|
|
473
|
+
audit_log (Optional[AuditLog]):
|
|
474
|
+
Optional audit log information to be included with the request.
|
|
475
|
+
|
|
476
|
+
Returns:
|
|
477
|
+
bool:
|
|
478
|
+
Returns `True` if the operation was successful.
|
|
479
|
+
|
|
480
|
+
Raises:
|
|
481
|
+
ValueError:
|
|
482
|
+
If required arguments are missing or invalid.
|
|
483
|
+
|
|
484
|
+
RuntimeError:
|
|
485
|
+
If the server version is not compatible or if an
|
|
486
|
+
unexpected response is returned.
|
|
487
|
+
"""
|
|
488
|
+
|
|
489
|
+
return block_account_action(
|
|
490
|
+
context=self._ctx,
|
|
491
|
+
account_name=account_name,
|
|
492
|
+
comment=comment,
|
|
493
|
+
audit_log=audit_log
|
|
494
|
+
)
|
|
495
|
+
|
|
496
|
+
def unblock_accounts(
|
|
497
|
+
self,
|
|
498
|
+
account_names: List[str],
|
|
499
|
+
audit_log: Optional[AuditLog] = None
|
|
500
|
+
) -> bool:
|
|
501
|
+
"""
|
|
502
|
+
Unblocks the specified accounts.
|
|
503
|
+
|
|
504
|
+
Args:
|
|
505
|
+
account_names (List[str]):
|
|
506
|
+
A list of account names to be removed from the list
|
|
507
|
+
of blocked accounts.
|
|
508
|
+
|
|
509
|
+
audit_log (Optional[AuditLog]):
|
|
510
|
+
Optional audit log information to be included with the request.
|
|
511
|
+
|
|
512
|
+
Returns:
|
|
513
|
+
bool:
|
|
514
|
+
Returns `True` if the operation was successful.
|
|
515
|
+
|
|
516
|
+
Raises:
|
|
517
|
+
ValueError:
|
|
518
|
+
If required arguments are missing or invalid.
|
|
519
|
+
|
|
520
|
+
RuntimeError:
|
|
521
|
+
If the server version is not compatible or if an
|
|
522
|
+
unexpected response is returned.
|
|
523
|
+
"""
|
|
524
|
+
|
|
525
|
+
return unblock_accounts_action(
|
|
526
|
+
context=self._ctx,
|
|
527
|
+
account_names=account_names,
|
|
528
|
+
audit_log=audit_log
|
|
529
|
+
)
|
|
530
|
+
|
|
531
|
+
def get_roles(self, identity_service_name: str) -> List[str]:
|
|
532
|
+
"""
|
|
533
|
+
Returns a collection of roles for the specified Identity Service.
|
|
534
|
+
|
|
535
|
+
Args:
|
|
536
|
+
identity_service_name (str):
|
|
537
|
+
The name of the Identity Service to be used for this operation.
|
|
538
|
+
|
|
539
|
+
Returns:
|
|
540
|
+
List[str]:
|
|
541
|
+
A list of roles defined for the specified Identity Service.
|
|
542
|
+
|
|
543
|
+
Raises:
|
|
544
|
+
ValueError:
|
|
545
|
+
If required arguments are missing or invalid.
|
|
546
|
+
|
|
547
|
+
RuntimeError:
|
|
548
|
+
If the server version is not compatible or if an
|
|
549
|
+
unexpected response is returned.
|
|
550
|
+
"""
|
|
551
|
+
|
|
552
|
+
return get_roles_action(
|
|
553
|
+
context=self._ctx,
|
|
554
|
+
identity_service_name=identity_service_name
|
|
555
|
+
)
|
|
556
|
+
|
|
557
|
+
def store_role(
|
|
558
|
+
self,
|
|
559
|
+
identity_service_name: str,
|
|
560
|
+
role_name: str,
|
|
561
|
+
ordering: Optional[int] = None,
|
|
562
|
+
audit_log: Optional[AuditLog] = None
|
|
563
|
+
) -> bool:
|
|
564
|
+
"""
|
|
565
|
+
Stores a new role in the Identity Service.
|
|
566
|
+
|
|
567
|
+
Args:
|
|
568
|
+
identity_service_name (str):
|
|
569
|
+
The name of the Identity Service to be used for this operation.
|
|
570
|
+
|
|
571
|
+
role_name (str):
|
|
572
|
+
The name of the role to be stored.
|
|
573
|
+
|
|
574
|
+
ordering (Optional[int]):
|
|
575
|
+
The ordering value of the role, used to define its position
|
|
576
|
+
relative to other roles.
|
|
577
|
+
|
|
578
|
+
audit_log (Optional[AuditLog]):
|
|
579
|
+
Optional audit log information to be included with the request.
|
|
580
|
+
|
|
581
|
+
Returns:
|
|
582
|
+
bool:
|
|
583
|
+
Returns `True` if the operation was successful.
|
|
584
|
+
|
|
585
|
+
Raises:
|
|
586
|
+
ValueError:
|
|
587
|
+
If required arguments are missing or invalid.
|
|
588
|
+
|
|
589
|
+
RuntimeError:
|
|
590
|
+
If the server version is not compatible or if an
|
|
591
|
+
unexpected response is returned.
|
|
592
|
+
"""
|
|
593
|
+
|
|
594
|
+
return store_role_action(
|
|
595
|
+
context=self._ctx,
|
|
596
|
+
identity_service_name=identity_service_name,
|
|
597
|
+
role_name=role_name,
|
|
598
|
+
ordering=ordering,
|
|
599
|
+
audit_log=audit_log
|
|
600
|
+
)
|
|
601
|
+
|
|
602
|
+
def rename_role(
|
|
603
|
+
self,
|
|
604
|
+
identity_service_name: str,
|
|
605
|
+
role_name: str,
|
|
606
|
+
new_role_name: str,
|
|
607
|
+
audit_log: Optional[AuditLog] = None
|
|
608
|
+
) -> bool:
|
|
609
|
+
"""
|
|
610
|
+
Benennt eine vorhandene Rolle um.
|
|
611
|
+
|
|
612
|
+
Args:
|
|
613
|
+
identity_service_name (str):
|
|
614
|
+
The name of the Identity Service to be used for this operation.
|
|
615
|
+
|
|
616
|
+
role_name (str):
|
|
617
|
+
Der Name der alten Rolle.
|
|
618
|
+
|
|
619
|
+
new_role_name (str):
|
|
620
|
+
Der neue Name der Rolle.
|
|
621
|
+
|
|
622
|
+
audit_log (Optional[AuditLog]):
|
|
623
|
+
Optional audit log information to be included with the request.
|
|
624
|
+
|
|
625
|
+
Returns:
|
|
626
|
+
bool:
|
|
627
|
+
Returns `True` if the operation was successful.
|
|
628
|
+
|
|
629
|
+
Raises:
|
|
630
|
+
ValueError:
|
|
631
|
+
If required arguments are missing or invalid.
|
|
632
|
+
|
|
633
|
+
RuntimeError:
|
|
634
|
+
If the server version is not compatible or if an
|
|
635
|
+
unexpected response is returned.
|
|
636
|
+
"""
|
|
637
|
+
|
|
638
|
+
return rename_role_action(
|
|
639
|
+
context=self._ctx,
|
|
640
|
+
identity_service_name=identity_service_name,
|
|
641
|
+
role_name=role_name,
|
|
642
|
+
new_role_name=new_role_name,
|
|
643
|
+
audit_log=audit_log
|
|
644
|
+
)
|
|
645
|
+
|
|
646
|
+
def remove_roles(
|
|
647
|
+
self,
|
|
648
|
+
identity_service_name: str,
|
|
649
|
+
role_names: List[str],
|
|
650
|
+
audit_log: Optional[AuditLog] = None
|
|
651
|
+
) -> bool:
|
|
652
|
+
"""
|
|
653
|
+
Deletes roles from the specified Identity Service.
|
|
654
|
+
|
|
655
|
+
Args:
|
|
656
|
+
identity_service_name (str):
|
|
657
|
+
The name of the Identity Service to be used for this operation.
|
|
658
|
+
|
|
659
|
+
role_names (List[str]):
|
|
660
|
+
A list of role names to be removed.
|
|
661
|
+
|
|
662
|
+
audit_log (Optional[AuditLog]):
|
|
663
|
+
Optional audit log information to be included with the request.
|
|
664
|
+
|
|
665
|
+
Returns:
|
|
666
|
+
bool:
|
|
667
|
+
Returns `True` if the operation was successful.
|
|
668
|
+
|
|
669
|
+
Raises:
|
|
670
|
+
ValueError:
|
|
671
|
+
If required arguments are missing or invalid.
|
|
672
|
+
|
|
673
|
+
RuntimeError:
|
|
674
|
+
If the server version is not compatible or if an
|
|
675
|
+
unexpected response is returned.
|
|
676
|
+
"""
|
|
677
|
+
|
|
678
|
+
return remove_roles_action(
|
|
679
|
+
context=self._ctx,
|
|
680
|
+
identity_service_name=identity_service_name,
|
|
681
|
+
role_names=role_names,
|
|
682
|
+
audit_log=audit_log
|
|
683
|
+
)
|
|
684
|
+
|
|
685
|
+
def get_permissions(
|
|
686
|
+
self,
|
|
687
|
+
identity_service_name: str,
|
|
688
|
+
role_name: str,
|
|
689
|
+
permission_path: Optional[str] = None,
|
|
690
|
+
controller_id: Optional[str] = None,
|
|
691
|
+
without_excluded: bool = False
|
|
692
|
+
) -> List[Tuple[str, bool]]:
|
|
693
|
+
"""
|
|
694
|
+
Returns one or more permissions for a given role and optional Controller ID.
|
|
695
|
+
|
|
696
|
+
Args:
|
|
697
|
+
identity_service_name (str):
|
|
698
|
+
The name of the Identity Service to be used for this operation.
|
|
699
|
+
|
|
700
|
+
role_name (str):
|
|
701
|
+
The name of the role for which permissions are requested.
|
|
702
|
+
|
|
703
|
+
permission_path (Optional[str]):
|
|
704
|
+
The specific permission path to be returned. If omitted,
|
|
705
|
+
all permissions assigned to the role are returned.
|
|
706
|
+
|
|
707
|
+
controller_id (Optional[str]):
|
|
708
|
+
The Controller ID for which permissions are requested.
|
|
709
|
+
If omitted, permissions are returned without filtering
|
|
710
|
+
by Controller.
|
|
711
|
+
|
|
712
|
+
without_excluded (bool):
|
|
713
|
+
If `True`, permissions marked as excluded are skipped.
|
|
714
|
+
|
|
715
|
+
Returns:
|
|
716
|
+
List[Tuple[str, bool]]:
|
|
717
|
+
A list of tuples in the format `(permission_path, excluded)`,
|
|
718
|
+
where `permission_path` is the permission identifier and the
|
|
719
|
+
boolean value indicates whether the permission is marked as excluded.
|
|
720
|
+
|
|
721
|
+
Raises:
|
|
722
|
+
ValueError:
|
|
723
|
+
If required arguments are missing or invalid.
|
|
724
|
+
|
|
725
|
+
RuntimeError:
|
|
726
|
+
If the server version is not compatible or if an
|
|
727
|
+
unexpected response is returned.
|
|
728
|
+
"""
|
|
729
|
+
|
|
730
|
+
return get_permissions_action(
|
|
731
|
+
context=self._ctx,
|
|
732
|
+
identity_service_name=identity_service_name,
|
|
733
|
+
role_name=role_name,
|
|
734
|
+
permission_path=permission_path,
|
|
735
|
+
controller_id=controller_id,
|
|
736
|
+
without_excluded=without_excluded
|
|
737
|
+
)
|
|
738
|
+
|
|
739
|
+
def set_permissions(
|
|
740
|
+
self,
|
|
741
|
+
identity_service_name: str,
|
|
742
|
+
role_name: str,
|
|
743
|
+
controller_id: str,
|
|
744
|
+
permissions: List[Tuple[str, bool]],
|
|
745
|
+
audit_log: Optional[AuditLog] = None
|
|
746
|
+
) -> bool:
|
|
747
|
+
"""
|
|
748
|
+
Stores permissions for a given role and Controller ID.
|
|
749
|
+
|
|
750
|
+
Args:
|
|
751
|
+
identity_service_name (str):
|
|
752
|
+
The name of the Identity Service to be used for this operation.
|
|
753
|
+
|
|
754
|
+
role_name (str):
|
|
755
|
+
The name of the role to which the permissions are assigned.
|
|
756
|
+
|
|
757
|
+
controller_id (str):
|
|
758
|
+
The Controller ID for which the permissions should be stored
|
|
759
|
+
|
|
760
|
+
permissions (List[Tuple[str, bool]]):
|
|
761
|
+
A list of tuples in the format `(permission_path, excluded)`,
|
|
762
|
+
where `permission_path` is the permission identifier and the
|
|
763
|
+
boolean value indicates whether the permission is marked as excluded.
|
|
764
|
+
|
|
765
|
+
audit_log (Optional[AuditLog]):
|
|
766
|
+
Optional audit log information to be included with the request.
|
|
767
|
+
|
|
768
|
+
Returns:
|
|
769
|
+
bool:
|
|
770
|
+
Returns `True` if the operation was successful.
|
|
771
|
+
|
|
772
|
+
Raises:
|
|
773
|
+
ValueError:
|
|
774
|
+
If required arguments are missing or invalid.
|
|
775
|
+
|
|
776
|
+
RuntimeError:
|
|
777
|
+
If the server version is not compatible or if an
|
|
778
|
+
unexpected response is returned.
|
|
779
|
+
"""
|
|
780
|
+
|
|
781
|
+
return set_permissions_action(
|
|
782
|
+
context=self._ctx,
|
|
783
|
+
identity_service_name=identity_service_name,
|
|
784
|
+
role_name=role_name,
|
|
785
|
+
controller_id=controller_id,
|
|
786
|
+
permissions=permissions,
|
|
787
|
+
audit_log=audit_log
|
|
788
|
+
)
|
|
789
|
+
|
|
790
|
+
def rename_permission(
|
|
791
|
+
self,
|
|
792
|
+
identity_service_name: str,
|
|
793
|
+
permission_path: str,
|
|
794
|
+
new_permission: Tuple[str, bool],
|
|
795
|
+
role_name: str,
|
|
796
|
+
controller_id: str,
|
|
797
|
+
audit_log: Optional[AuditLog] = None
|
|
798
|
+
) -> bool:
|
|
799
|
+
"""
|
|
800
|
+
Renames a permission for a given role and Controller ID.
|
|
801
|
+
|
|
802
|
+
Args:
|
|
803
|
+
identity_service_name (str):
|
|
804
|
+
The name of the Identity Service to be used for this operation.
|
|
805
|
+
|
|
806
|
+
permission_path (str):
|
|
807
|
+
The current permission path to be renamed.
|
|
808
|
+
|
|
809
|
+
new_permission (Tuple[str, bool]):
|
|
810
|
+
A tuple in the format `(new_permission_path, excluded)`,
|
|
811
|
+
where `new_permission_path` is the updated permission identifier
|
|
812
|
+
and the boolean value indicates whether the permission is marked
|
|
813
|
+
as excluded.
|
|
814
|
+
|
|
815
|
+
role_name (str):
|
|
816
|
+
The name of the role to which the permission is assigned.
|
|
817
|
+
|
|
818
|
+
controller_id (str):
|
|
819
|
+
The Controller ID for which the permission applies.
|
|
820
|
+
|
|
821
|
+
audit_log (Optional[AuditLog]):
|
|
822
|
+
Optional audit log information to be included with the request.
|
|
823
|
+
|
|
824
|
+
Returns:
|
|
825
|
+
bool:
|
|
826
|
+
Returns `True` if the operation was successful.
|
|
827
|
+
|
|
828
|
+
Raises:
|
|
829
|
+
ValueError:
|
|
830
|
+
If required arguments are missing or invalid.
|
|
831
|
+
|
|
832
|
+
RuntimeError:
|
|
833
|
+
If the server version is not compatible or if an
|
|
834
|
+
unexpected response is returned.
|
|
835
|
+
"""
|
|
836
|
+
|
|
837
|
+
return rename_permission_action(
|
|
838
|
+
context=self._ctx,
|
|
839
|
+
identity_service_name=identity_service_name,
|
|
840
|
+
permission_path=permission_path,
|
|
841
|
+
new_permission=new_permission,
|
|
842
|
+
role_name=role_name,
|
|
843
|
+
controller_id=controller_id,
|
|
844
|
+
audit_log=audit_log
|
|
845
|
+
)
|
|
846
|
+
|
|
847
|
+
def remove_permissions(
|
|
848
|
+
self,
|
|
849
|
+
identity_service_name: str,
|
|
850
|
+
role_name: str,
|
|
851
|
+
permission_paths: List[str],
|
|
852
|
+
controller_id: Optional[str] = None,
|
|
853
|
+
audit_log: Optional[AuditLog] = None
|
|
854
|
+
) -> bool:
|
|
855
|
+
"""
|
|
856
|
+
Deletes permissions from a given role and Controller ID.
|
|
857
|
+
|
|
858
|
+
Args:
|
|
859
|
+
identity_service_name (str):
|
|
860
|
+
The name of the Identity Service to be used for this operation.
|
|
861
|
+
|
|
862
|
+
role_name (str):
|
|
863
|
+
The name of the role from which the permissions are removed.
|
|
864
|
+
|
|
865
|
+
permission_paths (List[str]):
|
|
866
|
+
A list of permission paths to be deleted from the specified
|
|
867
|
+
role and Controller ID.
|
|
868
|
+
|
|
869
|
+
controller_id (str):
|
|
870
|
+
The Controller ID for which the changes apply.
|
|
871
|
+
|
|
872
|
+
audit_log (Optional[AuditLog]):
|
|
873
|
+
Optional audit log information to be included with the request.
|
|
874
|
+
|
|
875
|
+
Returns:
|
|
876
|
+
bool:
|
|
877
|
+
Returns `True` if the operation was successful.
|
|
878
|
+
|
|
879
|
+
Raises:
|
|
880
|
+
ValueError:
|
|
881
|
+
If required arguments are missing or invalid.
|
|
882
|
+
|
|
883
|
+
RuntimeError:
|
|
884
|
+
If the server version is not compatible or if an
|
|
885
|
+
unexpected response is returned.
|
|
886
|
+
"""
|
|
887
|
+
|
|
888
|
+
return remove_permissions_action(
|
|
889
|
+
context=self._ctx,
|
|
890
|
+
identity_service_name=identity_service_name,
|
|
891
|
+
role_name=role_name,
|
|
892
|
+
permission_paths=permission_paths,
|
|
893
|
+
controller_id=controller_id,
|
|
894
|
+
audit_log=audit_log
|
|
895
|
+
)
|
|
896
|
+
|
|
897
|
+
def get_folder_permissions(
|
|
898
|
+
self,
|
|
899
|
+
identity_service_name: str,
|
|
900
|
+
role_name: str,
|
|
901
|
+
controller_id: str,
|
|
902
|
+
folder_name: Optional[str] = None
|
|
903
|
+
) -> List[Folder]:
|
|
904
|
+
"""
|
|
905
|
+
Returns a collection of folders for the given role and Controller ID.
|
|
906
|
+
|
|
907
|
+
Args:
|
|
908
|
+
identity_service_name (str):
|
|
909
|
+
The name of the Identity Service to be used for this operation.
|
|
910
|
+
|
|
911
|
+
role_name (str):
|
|
912
|
+
The name of the role for which folders are requested.
|
|
913
|
+
|
|
914
|
+
controller_id (str):
|
|
915
|
+
The Controller ID for which folders should be returned.
|
|
916
|
+
|
|
917
|
+
folder_name (Optional[str]):
|
|
918
|
+
If provided, only the specified folder is returned.
|
|
919
|
+
|
|
920
|
+
Returns:
|
|
921
|
+
List[Folder]:
|
|
922
|
+
A collection of folders associated with the specified
|
|
923
|
+
role and Controller ID.
|
|
924
|
+
|
|
925
|
+
Raises:
|
|
926
|
+
ValueError:
|
|
927
|
+
If required arguments are missing or invalid.
|
|
928
|
+
|
|
929
|
+
RuntimeError:
|
|
930
|
+
If the server version is not compatible or if an
|
|
931
|
+
unexpected response is returned.
|
|
932
|
+
"""
|
|
933
|
+
|
|
934
|
+
return get_folder_permissions_action(
|
|
935
|
+
context=self._ctx,
|
|
936
|
+
identity_service_name=identity_service_name,
|
|
937
|
+
role_name=role_name,
|
|
938
|
+
controller_id=controller_id,
|
|
939
|
+
folder_name=folder_name
|
|
940
|
+
)
|
|
941
|
+
|
|
942
|
+
def set_folder_permissions(
|
|
943
|
+
self,
|
|
944
|
+
identity_service_name: str,
|
|
945
|
+
role_name: str,
|
|
946
|
+
controller_id: str,
|
|
947
|
+
folders: List[Folder],
|
|
948
|
+
audit_log: Optional[AuditLog] = None
|
|
949
|
+
) -> bool:
|
|
950
|
+
"""
|
|
951
|
+
Stores folders for a given role and Controller ID.
|
|
952
|
+
|
|
953
|
+
Args:
|
|
954
|
+
identity_service_name (str):
|
|
955
|
+
The name of the Identity Service to be used for this operation.
|
|
956
|
+
|
|
957
|
+
role_name (str):
|
|
958
|
+
The name of the role for which the folders should be stored.
|
|
959
|
+
|
|
960
|
+
controller_id (str):
|
|
961
|
+
The Controller ID for which the folders should be stored
|
|
962
|
+
|
|
963
|
+
folders (List[Folder]):
|
|
964
|
+
A list of folders to be stored for the specified
|
|
965
|
+
role and Controller ID.
|
|
966
|
+
|
|
967
|
+
audit_log (Optional[AuditLog]):
|
|
968
|
+
Optional audit log information to be included with the request.
|
|
969
|
+
|
|
970
|
+
Returns:
|
|
971
|
+
bool:
|
|
972
|
+
Returns `True` if the operation was successful.
|
|
973
|
+
|
|
974
|
+
Raises:
|
|
975
|
+
ValueError:
|
|
976
|
+
If required arguments are missing or invalid.
|
|
977
|
+
|
|
978
|
+
RuntimeError:
|
|
979
|
+
If the server version is not compatible or if an
|
|
980
|
+
unexpected response is returned.
|
|
981
|
+
"""
|
|
982
|
+
|
|
983
|
+
return set_folder_permissions_action(
|
|
984
|
+
context=self._ctx,
|
|
985
|
+
identity_service_name=identity_service_name,
|
|
986
|
+
role_name=role_name,
|
|
987
|
+
controller_id=controller_id,
|
|
988
|
+
folders=folders,
|
|
989
|
+
audit_log=audit_log
|
|
990
|
+
)
|
|
991
|
+
|
|
992
|
+
def rename_folder_permissions(
|
|
993
|
+
self,
|
|
994
|
+
identity_service_name: str,
|
|
995
|
+
folder_name: str,
|
|
996
|
+
new_folder: Folder,
|
|
997
|
+
controller_id: str,
|
|
998
|
+
role_name: str,
|
|
999
|
+
audit_log: Optional[AuditLog] = None
|
|
1000
|
+
) -> bool:
|
|
1001
|
+
"""
|
|
1002
|
+
Renames a folder for a given role and Controller ID.
|
|
1003
|
+
|
|
1004
|
+
Args:
|
|
1005
|
+
identity_service_name (str):
|
|
1006
|
+
The name of the Identity Service to be used for this operation.
|
|
1007
|
+
|
|
1008
|
+
folder_name (str):
|
|
1009
|
+
The current name or path of the folder to be renamed.
|
|
1010
|
+
|
|
1011
|
+
new_folder (Folder):
|
|
1012
|
+
The new folder definition, including the updated path
|
|
1013
|
+
and recursive settings.
|
|
1014
|
+
|
|
1015
|
+
controller_id (str):
|
|
1016
|
+
The Controller ID for which the folder should be renamed.
|
|
1017
|
+
|
|
1018
|
+
role_name (str):
|
|
1019
|
+
The name of the role for which the folder is assigned.
|
|
1020
|
+
|
|
1021
|
+
audit_log (Optional[AuditLog]):
|
|
1022
|
+
Optional audit log information to be included with the request.
|
|
1023
|
+
|
|
1024
|
+
Returns:
|
|
1025
|
+
bool:
|
|
1026
|
+
Returns `True` if the operation was successful.
|
|
1027
|
+
|
|
1028
|
+
Raises:
|
|
1029
|
+
ValueError:
|
|
1030
|
+
If required arguments are missing or invalid.
|
|
1031
|
+
|
|
1032
|
+
RuntimeError:
|
|
1033
|
+
If the server version is not compatible or if an
|
|
1034
|
+
unexpected response is returned.
|
|
1035
|
+
"""
|
|
1036
|
+
|
|
1037
|
+
return rename_folder_permissions_action(
|
|
1038
|
+
context=self._ctx,
|
|
1039
|
+
identity_service_name=identity_service_name,
|
|
1040
|
+
folder_name=folder_name,
|
|
1041
|
+
new_folder=new_folder,
|
|
1042
|
+
controller_id=controller_id,
|
|
1043
|
+
role_name=role_name,
|
|
1044
|
+
audit_log=audit_log
|
|
1045
|
+
)
|
|
1046
|
+
|
|
1047
|
+
def remove_folder_permissions(
|
|
1048
|
+
self,
|
|
1049
|
+
identity_service_name: str,
|
|
1050
|
+
role_name: str,
|
|
1051
|
+
controller_id: str,
|
|
1052
|
+
folder_names: List[str],
|
|
1053
|
+
audit_log: Optional[AuditLog] = None
|
|
1054
|
+
) -> bool:
|
|
1055
|
+
"""
|
|
1056
|
+
Deletes folders from a given role and Controller ID.
|
|
1057
|
+
|
|
1058
|
+
Args:
|
|
1059
|
+
identity_service_name (str):
|
|
1060
|
+
The name of the Identity Service to be used for this operation.
|
|
1061
|
+
|
|
1062
|
+
role_name (str):
|
|
1063
|
+
The name of the role from which the folders are removed.
|
|
1064
|
+
|
|
1065
|
+
controller_id (str):
|
|
1066
|
+
The Controller ID for which the folders should be removed.
|
|
1067
|
+
|
|
1068
|
+
folder_names (List[str]):
|
|
1069
|
+
A list of folder names to be deleted from the specified
|
|
1070
|
+
role and Controller ID.
|
|
1071
|
+
|
|
1072
|
+
audit_log (Optional[AuditLog]):
|
|
1073
|
+
Optional audit log information to be included with the request.
|
|
1074
|
+
|
|
1075
|
+
Returns:
|
|
1076
|
+
bool:
|
|
1077
|
+
Returns `True` if the operation was successful.
|
|
1078
|
+
|
|
1079
|
+
Raises:
|
|
1080
|
+
ValueError:
|
|
1081
|
+
If required arguments are missing or invalid.
|
|
1082
|
+
|
|
1083
|
+
RuntimeError:
|
|
1084
|
+
If the server version is not compatible or if an
|
|
1085
|
+
unexpected response is returned.
|
|
1086
|
+
"""
|
|
1087
|
+
|
|
1088
|
+
return remove_folder_permissions_action(
|
|
1089
|
+
context=self._ctx,
|
|
1090
|
+
identity_service_name=identity_service_name,
|
|
1091
|
+
role_name=role_name,
|
|
1092
|
+
controller_id=controller_id,
|
|
1093
|
+
folder_names=folder_names,
|
|
1094
|
+
audit_log=audit_log
|
|
1095
|
+
)
|
|
1096
|
+
|
|
1097
|
+
def get_identity_services(
|
|
1098
|
+
self,
|
|
1099
|
+
identity_service_name: Optional[str] = None
|
|
1100
|
+
) -> List[IdentityService]:
|
|
1101
|
+
"""
|
|
1102
|
+
Returns a collection of Identity Services.
|
|
1103
|
+
|
|
1104
|
+
Args:
|
|
1105
|
+
identity_service_name (Optional[str]):
|
|
1106
|
+
The name of the Identity Service. If `None`, all
|
|
1107
|
+
available Identity Services are returned.
|
|
1108
|
+
|
|
1109
|
+
Returns:
|
|
1110
|
+
List[IdentityService]:
|
|
1111
|
+
A list of Identity Services matching the specified criteria.
|
|
1112
|
+
|
|
1113
|
+
Raises:
|
|
1114
|
+
ValueError:
|
|
1115
|
+
If required arguments are missing or invalid.
|
|
1116
|
+
|
|
1117
|
+
RuntimeError:
|
|
1118
|
+
If the server version is not compatible or if an
|
|
1119
|
+
unexpected response is returned.
|
|
1120
|
+
"""
|
|
1121
|
+
|
|
1122
|
+
return get_identity_services_action(
|
|
1123
|
+
context=self._ctx,
|
|
1124
|
+
identity_service_name=identity_service_name
|
|
1125
|
+
)
|
|
1126
|
+
|
|
1127
|
+
def store_identity_service(
|
|
1128
|
+
self,
|
|
1129
|
+
identity_service: IdentityService,
|
|
1130
|
+
audit_log: Optional[AuditLog] = None
|
|
1131
|
+
) -> bool:
|
|
1132
|
+
"""
|
|
1133
|
+
Stores an Identity Service.
|
|
1134
|
+
|
|
1135
|
+
Args:
|
|
1136
|
+
identity_service (IdentityService):
|
|
1137
|
+
The Identity Service to be created stored.
|
|
1138
|
+
|
|
1139
|
+
audit_log (Optional[AuditLog]):
|
|
1140
|
+
Optional audit log information to be included with the request.
|
|
1141
|
+
|
|
1142
|
+
Returns:
|
|
1143
|
+
bool:
|
|
1144
|
+
Returns `True` if the operation was successful.
|
|
1145
|
+
|
|
1146
|
+
Raises:
|
|
1147
|
+
ValueError:
|
|
1148
|
+
If required arguments are missing or invalid.
|
|
1149
|
+
|
|
1150
|
+
RuntimeError:
|
|
1151
|
+
If the server version is not compatible or if an
|
|
1152
|
+
unexpected response is returned.
|
|
1153
|
+
"""
|
|
1154
|
+
|
|
1155
|
+
return store_identity_service_action(
|
|
1156
|
+
context=self._ctx,
|
|
1157
|
+
identity_service=identity_service,
|
|
1158
|
+
audit_log=audit_log
|
|
1159
|
+
)
|
|
1160
|
+
|
|
1161
|
+
def rename_identity_service(
|
|
1162
|
+
self,
|
|
1163
|
+
identity_service_name: str,
|
|
1164
|
+
new_identity_service_name: str,
|
|
1165
|
+
audit_log: Optional[AuditLog] = None
|
|
1166
|
+
) -> bool:
|
|
1167
|
+
"""
|
|
1168
|
+
Renames an Identity Service.
|
|
1169
|
+
|
|
1170
|
+
Args:
|
|
1171
|
+
identity_service_name (str):
|
|
1172
|
+
The current name of the Identity Service to be renamed.
|
|
1173
|
+
|
|
1174
|
+
new_identity_service_name (str):
|
|
1175
|
+
The new name to be assigned to the Identity Service.
|
|
1176
|
+
|
|
1177
|
+
audit_log (Optional[AuditLog]):
|
|
1178
|
+
Optional audit log information to be included with the request.
|
|
1179
|
+
|
|
1180
|
+
Returns:
|
|
1181
|
+
bool:
|
|
1182
|
+
Returns `True` if the operation was successful.
|
|
1183
|
+
|
|
1184
|
+
Raises:
|
|
1185
|
+
ValueError:
|
|
1186
|
+
If required arguments are missing or invalid.
|
|
1187
|
+
|
|
1188
|
+
RuntimeError:
|
|
1189
|
+
If the server version is not compatible or if an
|
|
1190
|
+
unexpected response is returned.
|
|
1191
|
+
"""
|
|
1192
|
+
|
|
1193
|
+
return rename_identity_service_action(
|
|
1194
|
+
context=self._ctx,
|
|
1195
|
+
identity_service_name=identity_service_name,
|
|
1196
|
+
new_identity_service_name=new_identity_service_name,
|
|
1197
|
+
audit_log=audit_log
|
|
1198
|
+
)
|
|
1199
|
+
|
|
1200
|
+
def remove_identity_service(
|
|
1201
|
+
self,
|
|
1202
|
+
identity_service_name: str,
|
|
1203
|
+
audit_log: Optional[AuditLog] = None
|
|
1204
|
+
) -> bool:
|
|
1205
|
+
"""
|
|
1206
|
+
Deletes an Identity Service.
|
|
1207
|
+
|
|
1208
|
+
Args:
|
|
1209
|
+
identity_service_name (str):
|
|
1210
|
+
The name of the Identity Service to be deleted.
|
|
1211
|
+
|
|
1212
|
+
audit_log (Optional[AuditLog]):
|
|
1213
|
+
Optional audit log information to be included with the request.
|
|
1214
|
+
|
|
1215
|
+
Returns:
|
|
1216
|
+
bool:
|
|
1217
|
+
Returns `True` if the operation was successful.
|
|
1218
|
+
|
|
1219
|
+
Raises:
|
|
1220
|
+
ValueError:
|
|
1221
|
+
If required arguments are missing or invalid.
|
|
1222
|
+
|
|
1223
|
+
RuntimeError:
|
|
1224
|
+
If the server version is not compatible or if an
|
|
1225
|
+
unexpected response is returned.
|
|
1226
|
+
"""
|
|
1227
|
+
|
|
1228
|
+
return remove_identity_service_action(
|
|
1229
|
+
context=self._ctx,
|
|
1230
|
+
identity_service_name=identity_service_name,
|
|
1231
|
+
audit_log=audit_log
|
|
1232
|
+
)
|
|
1233
|
+
|
|
1234
|
+
def get_identity_service_settings(
|
|
1235
|
+
self,
|
|
1236
|
+
identity_service_name: str,
|
|
1237
|
+
identity_service_type: Literal['KEYCLOAK', 'KEYCLOAK-JOC', 'LDAP', 'LDAP-JOC', 'OIDC', 'OIDC-JOC', 'FIDO', 'JOC', 'CERTIFICATE']
|
|
1238
|
+
) -> Dict[str, Any]:
|
|
1239
|
+
"""
|
|
1240
|
+
Retrieves the configuration settings of the specified Identity Service
|
|
1241
|
+
from the server database.
|
|
1242
|
+
|
|
1243
|
+
Args:
|
|
1244
|
+
identity_service_name (str):
|
|
1245
|
+
The name of the Identity Service for which the configuration
|
|
1246
|
+
settings are requested.
|
|
1247
|
+
|
|
1248
|
+
identity_service_type (Literal['KEYCLOAK', 'KEYCLOAK-JOC', 'LDAP', 'LDAP-JOC', 'OIDC', 'OIDC-JOC', 'FIDO', 'JOC', 'CERTIFICATE']):
|
|
1249
|
+
The type of the Identity Service whose configuration should be returned.
|
|
1250
|
+
|
|
1251
|
+
Returns:
|
|
1252
|
+
Dict ([str, Any]):
|
|
1253
|
+
A dictionary containing the configuration settings of
|
|
1254
|
+
the specified Identity Service.
|
|
1255
|
+
|
|
1256
|
+
Raises:
|
|
1257
|
+
ValueError:
|
|
1258
|
+
If required arguments are missing or invalid.
|
|
1259
|
+
|
|
1260
|
+
RuntimeError:
|
|
1261
|
+
If the server version is not compatible or if an
|
|
1262
|
+
unexpected response is returned.
|
|
1263
|
+
"""
|
|
1264
|
+
|
|
1265
|
+
return get_identity_service_settings_action(
|
|
1266
|
+
context=self._ctx,
|
|
1267
|
+
identity_service_name=identity_service_name,
|
|
1268
|
+
identity_service_type=identity_service_type
|
|
1269
|
+
)
|
|
1270
|
+
|
|
1271
|
+
def store_identity_service_settings(
|
|
1272
|
+
self,
|
|
1273
|
+
identity_service_name: str,
|
|
1274
|
+
identity_service_type: Literal['KEYCLOAK', 'KEYCLOAK-JOC', 'LDAP', 'LDAP-JOC', 'OIDC', 'OIDC-JOC', 'FIDO', 'JOC', 'CERTIFICATE'],
|
|
1275
|
+
settings: Dict[str, Any]
|
|
1276
|
+
) -> bool:
|
|
1277
|
+
"""
|
|
1278
|
+
Stores configuration settings for the specified Identity Service
|
|
1279
|
+
in the server database.
|
|
1280
|
+
|
|
1281
|
+
Args:
|
|
1282
|
+
identity_service_name (str):
|
|
1283
|
+
The name of the Identity Service for which the configuration
|
|
1284
|
+
settings should be stored.
|
|
1285
|
+
|
|
1286
|
+
identity_service_type (Literal['KEYCLOAK', 'KEYCLOAK-JOC', 'LDAP', 'LDAP-JOC', 'OIDC', 'OIDC-JOC', 'FIDO', 'JOC', 'CERTIFICATE']):
|
|
1287
|
+
The type of the Identity Service whose configuration is being stored.
|
|
1288
|
+
|
|
1289
|
+
settings (Dict[str, Any]):
|
|
1290
|
+
A dictionary containing the configuration settings
|
|
1291
|
+
to be stored.
|
|
1292
|
+
|
|
1293
|
+
Returns:
|
|
1294
|
+
bool:
|
|
1295
|
+
Returns `True` if the configuration was successfully stored.
|
|
1296
|
+
|
|
1297
|
+
Raises:
|
|
1298
|
+
ValueError:
|
|
1299
|
+
If required arguments are missing or invalid.
|
|
1300
|
+
|
|
1301
|
+
RuntimeError:
|
|
1302
|
+
If the server version is not compatible or if an
|
|
1303
|
+
unexpected response is returned.
|
|
1304
|
+
"""
|
|
1305
|
+
|
|
1306
|
+
return store_identity_service_settings_action(
|
|
1307
|
+
context=self._ctx,
|
|
1308
|
+
identity_service_name=identity_service_name,
|
|
1309
|
+
identity_service_type=identity_service_type,
|
|
1310
|
+
settings=settings
|
|
1311
|
+
)
|