From 27b87ef31fbf32f1bb7b215752f0a0021cd58b03 Mon Sep 17 00:00:00 2001
From: "authentik-automation[bot]"
<135050075+authentik-automation[bot]@users.noreply.github.com>
Date: Wed, 13 May 2026 12:35:53 +0000
Subject: [PATCH 01/11] Version 2026.5.0-rc1
---
.gitignore | 68 +
.openapi-generator/FILES | 2746 +
.openapi-generator/VERSION | 1 +
README.md | 2137 +-
authentik_client/__init__.py | 1863 +
authentik_client/api/__init__.py | 29 +
authentik_client/api/admin_api.py | 3871 +
authentik_client/api/authenticators_api.py | 24016 ++++++
authentik_client/api/core_api.py | 21558 ++++++
authentik_client/api/crypto_api.py | 2955 +
authentik_client/api/endpoints_api.py | 20134 +++++
authentik_client/api/enterprise_api.py | 2828 +
authentik_client/api/events_api.py | 10350 +++
authentik_client/api/flows_api.py | 6461 ++
authentik_client/api/lifecycle_api.py | 3001 +
authentik_client/api/managed_api.py | 2900 +
authentik_client/api/oauth2_api.py | 3508 +
authentik_client/api/outposts_api.py | 10218 +++
authentik_client/api/policies_api.py | 23004 ++++++
authentik_client/api/propertymappings_api.py | 32520 ++++++++
authentik_client/api/providers_api.py | 37854 ++++++++++
authentik_client/api/rac_api.py | 3852 +
authentik_client/api/rbac_api.py | 6690 ++
authentik_client/api/reports_api.py | 886 +
authentik_client/api/root_api.py | 288 +
authentik_client/api/schema_api.py | 327 +
authentik_client/api/sources_api.py | 51640 +++++++++++++
authentik_client/api/ssf_api.py | 947 +
authentik_client/api/stages_api.py | 62406 ++++++++++++++++
authentik_client/api/tasks_api.py | 3080 +
authentik_client/api/tenants_api.py | 4080 +
authentik_client/api_client.py | 805 +
authentik_client/api_response.py | 21 +
authentik_client/configuration.py | 606 +
authentik_client/exceptions.py | 219 +
authentik_client/models/__init__.py | 900 +
.../models/access_denied_challenge.py | 118 +
.../models/account_lockdown_stage.py | 137 +
.../models/account_lockdown_stage_request.py | 106 +
.../models/agent_authentication_response.py | 89 +
authentik_client/models/agent_config.py | 141 +
authentik_client/models/agent_connector.py | 143 +
.../models/agent_connector_request.py | 127 +
.../agent_psso_device_registration_request.py | 96 +
...agent_psso_device_registration_response.py | 99 +
.../agent_psso_user_registration_request.py | 94 +
.../models/agent_token_response.py | 91 +
authentik_client/models/alg_enum.py | 40 +
authentik_client/models/app.py | 91 +
authentik_client/models/app_enum.py | 116 +
.../apple_challenge_response_request.py | 90 +
.../apple_independent_secure_enclave.py | 98 +
...pple_independent_secure_enclave_request.py | 99 +
.../models/apple_login_challenge.py | 120 +
authentik_client/models/application.py | 188 +
.../models/application_entitlement.py | 98 +
.../models/application_entitlement_request.py | 95 +
.../models/application_request.py | 128 +
authentik_client/models/auth_type_enum.py | 38 +
.../models/authenticated_session.py | 141 +
.../models/authenticated_session_asn.py | 108 +
.../models/authenticated_session_geo_ip.py | 117 +
.../authenticated_session_user_agent.py | 107 +
...authenticated_session_user_agent_device.py | 103 +
.../authenticated_session_user_agent_os.py | 117 +
...enticated_session_user_agent_user_agent.py | 95 +
.../models/authentication_enum.py | 43 +
.../models/authenticator_attachment_enum.py | 38 +
.../models/authenticator_duo_challenge.py | 122 +
...nticator_duo_challenge_response_request.py | 90 +
.../models/authenticator_duo_stage.py | 137 +
...icator_duo_stage_device_import_response.py | 95 +
..._duo_stage_manual_device_import_request.py | 92 +
.../models/authenticator_duo_stage_request.py | 110 +
.../models/authenticator_email_challenge.py | 125 +
...icator_email_challenge_response_request.py | 94 +
.../models/authenticator_email_stage.py | 156 +
.../authenticator_email_stage_request.py | 124 +
.../authenticator_endpoint_gdtc_stage.py | 133 +
...thenticator_endpoint_gdtc_stage_request.py | 102 +
.../models/authenticator_sms_challenge.py | 118 +
...nticator_sms_challenge_response_request.py | 94 +
.../models/authenticator_sms_stage.py | 154 +
.../models/authenticator_sms_stage_request.py | 123 +
.../models/authenticator_static_challenge.py | 118 +
...cator_static_challenge_response_request.py | 90 +
.../models/authenticator_static_stage.py | 136 +
.../authenticator_static_stage_request.py | 104 +
.../models/authenticator_totp_challenge.py | 118 +
...ticator_totp_challenge_response_request.py | 92 +
.../models/authenticator_totp_stage.py | 134 +
.../authenticator_totp_stage_request.py | 103 +
.../models/authenticator_validate_stage.py | 160 +
.../authenticator_validate_stage_request.py | 117 +
.../authenticator_validation_challenge.py | 136 +
...r_validation_challenge_response_request.py | 104 +
.../authenticator_web_authn_challenge.py | 118 +
...or_web_authn_challenge_response_request.py | 92 +
.../models/authenticator_web_authn_stage.py | 166 +
.../authenticator_web_authn_stage_request.py | 122 +
.../authorization_code_auth_method_enum.py | 38 +
.../auto_submit_challenge_response_request.py | 90 +
.../models/autosubmit_challenge.py | 118 +
authentik_client/models/backends_enum.py | 40 +
authentik_client/models/binding_type_enum.py | 39 +
authentik_client/models/blueprint_file.py | 102 +
.../models/blueprint_import_result.py | 103 +
authentik_client/models/blueprint_instance.py | 124 +
.../models/blueprint_instance_request.py | 98 +
.../models/blueprint_instance_status_enum.py | 41 +
authentik_client/models/brand.py | 173 +
authentik_client/models/brand_request.py | 170 +
.../models/bulk_delete_session_response.py | 89 +
authentik_client/models/cache.py | 91 +
authentik_client/models/capabilities_enum.py | 43 +
authentik_client/models/captcha_challenge.py | 122 +
.../captcha_challenge_response_request.py | 92 +
authentik_client/models/captcha_stage.py | 136 +
.../models/captcha_stage_request.py | 106 +
.../models/cert_attribute_enum.py | 39 +
authentik_client/models/certificate_data.py | 91 +
.../models/certificate_generation_request.py | 97 +
.../models/certificate_key_pair.py | 162 +
.../certificate_key_pair_key_type_enum.py | 41 +
.../models/certificate_key_pair_request.py | 94 +
authentik_client/models/challenge_types.py | 533 +
authentik_client/models/client_type_enum.py | 38 +
.../models/compatibility_mode_enum.py | 42 +
authentik_client/models/config.py | 102 +
authentik_client/models/connection_token.py | 118 +
.../models/connection_token_request.py | 94 +
authentik_client/models/connector.py | 110 +
authentik_client/models/consent_challenge.py | 139 +
.../consent_challenge_response_request.py | 92 +
authentik_client/models/consent_mode_enum.py | 39 +
authentik_client/models/consent_permission.py | 91 +
authentik_client/models/consent_stage.py | 127 +
.../models/consent_stage_request.py | 95 +
authentik_client/models/content_type.py | 103 +
authentik_client/models/content_type_enum.py | 39 +
.../models/contextual_flow_info.py | 107 +
.../contextual_flow_info_layout_enum.py | 43 +
authentik_client/models/country_code_enum.py | 285 +
authentik_client/models/current_brand.py | 163 +
.../models/current_brand_flags.py | 95 +
authentik_client/models/data_export.py | 123 +
.../models/delivery_method_enum.py | 40 +
authentik_client/models/denied_action_enum.py | 39 +
authentik_client/models/deny_stage.py | 124 +
authentik_client/models/deny_stage_request.py | 92 +
authentik_client/models/detailed_country.py | 92 +
authentik_client/models/device.py | 145 +
.../models/device_access_group.py | 96 +
.../models/device_access_group_request.py | 92 +
authentik_client/models/device_challenge.py | 102 +
.../models/device_challenge_request.py | 103 +
.../models/device_classes_enum.py | 42 +
authentik_client/models/device_connection.py | 113 +
.../models/device_fact_snapshot.py | 115 +
authentik_client/models/device_facts.py | 197 +
.../models/device_facts_os_family.py | 44 +
.../models/device_facts_request.py | 197 +
authentik_client/models/device_group.py | 91 +
.../models/device_group_request.py | 92 +
authentik_client/models/device_summary.py | 93 +
authentik_client/models/device_user.py | 95 +
.../models/device_user_binding.py | 184 +
.../models/device_user_binding_request.py | 124 +
.../models/device_user_request.py | 96 +
.../models/digest_algorithm_enum.py | 40 +
authentik_client/models/digits_enum.py | 38 +
authentik_client/models/disk.py | 99 +
authentik_client/models/disk_request.py | 100 +
.../models/docker_service_connection.py | 128 +
.../docker_service_connection_request.py | 109 +
authentik_client/models/domain.py | 99 +
authentik_client/models/domain_request.py | 95 +
authentik_client/models/dummy_challenge.py | 114 +
.../dummy_challenge_response_request.py | 90 +
authentik_client/models/dummy_policy.py | 123 +
.../models/dummy_policy_request.py | 98 +
authentik_client/models/dummy_stage.py | 124 +
.../models/dummy_stage_request.py | 92 +
authentik_client/models/duo_device.py | 102 +
.../models/duo_device_enrollment_status.py | 90 +
authentik_client/models/duo_device_request.py | 90 +
authentik_client/models/duo_response_enum.py | 39 +
authentik_client/models/email_challenge.py | 112 +
.../email_challenge_response_request.py | 90 +
authentik_client/models/email_device.py | 106 +
.../models/email_device_request.py | 90 +
authentik_client/models/email_stage.py | 151 +
.../models/email_stage_request.py | 120 +
authentik_client/models/endpoint.py | 128 +
.../models/endpoint_agent_challenge.py | 116 +
...dpoint_agent_challenge_response_request.py | 97 +
.../models/endpoint_auth_mode_enum.py | 38 +
authentik_client/models/endpoint_device.py | 129 +
.../models/endpoint_device_details.py | 147 +
.../models/endpoint_device_request.py | 118 +
authentik_client/models/endpoint_request.py | 107 +
authentik_client/models/endpoint_stage.py | 135 +
.../models/endpoint_stage_request.py | 96 +
authentik_client/models/enroll_request.py | 92 +
authentik_client/models/enrollment_token.py | 126 +
.../models/enrollment_token_request.py | 110 +
authentik_client/models/error_detail.py | 91 +
.../models/error_reporting_config.py | 107 +
authentik_client/models/event.py | 117 +
authentik_client/models/event_actions.py | 69 +
.../models/event_matcher_policy.py | 154 +
.../models/event_matcher_policy_request.py | 130 +
authentik_client/models/event_request.py | 109 +
authentik_client/models/event_stats.py | 91 +
authentik_client/models/event_top_per_user.py | 93 +
authentik_client/models/event_volume.py | 95 +
.../models/events_requested_enum.py | 45 +
.../models/expiring_base_grant_model.py | 117 +
authentik_client/models/expression_policy.py | 118 +
.../models/expression_policy_request.py | 94 +
.../models/extra_role_object_permission.py | 126 +
authentik_client/models/file_list.py | 104 +
authentik_client/models/fleet_connector.py | 124 +
.../models/fleet_connector_request.py | 110 +
authentik_client/models/flow.py | 165 +
.../models/flow_challenge_response_request.py | 477 +
.../models/flow_designation_enum.py | 43 +
authentik_client/models/flow_diagram.py | 91 +
.../models/flow_error_challenge.py | 118 +
authentik_client/models/flow_inspection.py | 104 +
.../models/flow_inspector_plan.py | 110 +
authentik_client/models/flow_layout_enum.py | 43 +
authentik_client/models/flow_request.py | 123 +
authentik_client/models/flow_set.py | 135 +
authentik_client/models/flow_stage_binding.py | 121 +
.../models/flow_stage_binding_request.py | 105 +
authentik_client/models/footer_link.py | 100 +
authentik_client/models/force_binding_enum.py | 38 +
authentik_client/models/format_enum.py | 38 +
authentik_client/models/frame_challenge.py | 118 +
.../frame_challenge_response_request.py | 90 +
authentik_client/models/generic_error.py | 91 +
authentik_client/models/geo_ip_policy.py | 146 +
.../geo_ip_policy_countries_obj_inner.py | 92 +
.../models/geo_ip_policy_request.py | 109 +
authentik_client/models/geoip_binding_enum.py | 40 +
authentik_client/models/global_task_status.py | 127 +
.../models/google_chrome_connector.py | 121 +
.../models/google_chrome_connector_request.py | 97 +
.../models/google_endpoint_device.py | 93 +
.../models/google_endpoint_device_request.py | 93 +
.../models/google_workspace_provider.py | 161 +
.../models/google_workspace_provider_group.py | 110 +
...google_workspace_provider_group_request.py | 95 +
.../google_workspace_provider_mapping.py | 119 +
...ogle_workspace_provider_mapping_request.py | 99 +
.../google_workspace_provider_request.py | 123 +
.../models/google_workspace_provider_user.py | 110 +
.../google_workspace_provider_user_request.py | 94 +
authentik_client/models/grant_types_enum.py | 43 +
authentik_client/models/group.py | 190 +
.../group_kerberos_source_connection.py | 115 +
...roup_kerberos_source_connection_request.py | 95 +
.../models/group_ldap_source_connection.py | 123 +
.../group_ldap_source_connection_request.py | 95 +
.../models/group_matching_mode_enum.py | 39 +
.../models/group_o_auth_source_connection.py | 115 +
.../group_o_auth_source_connection_request.py | 95 +
.../models/group_plex_source_connection.py | 115 +
.../group_plex_source_connection_request.py | 95 +
authentik_client/models/group_request.py | 101 +
.../models/group_saml_source_connection.py | 115 +
.../group_saml_source_connection_request.py | 95 +
.../models/group_source_connection.py | 115 +
.../models/group_source_connection_request.py | 95 +
.../group_telegram_source_connection.py | 115 +
...roup_telegram_source_connection_request.py | 95 +
authentik_client/models/hardware.py | 99 +
authentik_client/models/hardware_request.py | 100 +
.../models/identification_challenge.py | 177 +
...entification_challenge_response_request.py | 118 +
.../models/identification_stage.py | 179 +
.../models/identification_stage_request.py | 148 +
.../models/iframe_logout_challenge.py | 122 +
...frame_logout_challenge_response_request.py | 90 +
.../models/impersonation_request.py | 90 +
.../models/initial_permissions.py | 111 +
.../models/initial_permissions_request.py | 95 +
authentik_client/models/install_id.py | 89 +
authentik_client/models/intent_enum.py | 40 +
.../models/invalid_response_action_enum.py | 39 +
authentik_client/models/invitation.py | 140 +
authentik_client/models/invitation_request.py | 120 +
.../models/invitation_send_email_request.py | 96 +
authentik_client/models/invitation_stage.py | 124 +
.../models/invitation_stage_request.py | 92 +
authentik_client/models/issuer_mode_enum.py | 38 +
authentik_client/models/kadmin_type_enum.py | 38 +
authentik_client/models/kerberos_source.py | 217 +
.../kerberos_source_property_mapping.py | 119 +
...erberos_source_property_mapping_request.py | 99 +
.../models/kerberos_source_request.py | 168 +
authentik_client/models/key_type_enum.py | 41 +
.../models/kubernetes_service_connection.py | 116 +
.../kubernetes_service_connection_request.py | 96 +
authentik_client/models/lang_enum.py | 135 +
.../models/last_task_status_enum.py | 46 +
authentik_client/models/ldap_check_access.py | 95 +
authentik_client/models/ldap_debug.py | 99 +
.../models/ldap_outpost_config.py | 132 +
authentik_client/models/ldap_provider.py | 186 +
.../models/ldap_provider_request.py | 126 +
authentik_client/models/ldap_source.py | 250 +
.../models/ldap_source_property_mapping.py | 119 +
.../ldap_source_property_mapping_request.py | 99 +
.../models/ldap_source_request.py | 197 +
.../models/ldapapi_access_mode.py | 38 +
authentik_client/models/license.py | 111 +
authentik_client/models/license_flags_enum.py | 38 +
authentik_client/models/license_forecast.py | 95 +
authentik_client/models/license_request.py | 90 +
.../models/license_status_enum.py | 43 +
authentik_client/models/license_summary.py | 100 +
.../models/license_summary_status_enum.py | 43 +
.../models/lifecycle_iteration.py | 149 +
.../models/lifecycle_iteration_request.py | 90 +
.../models/lifecycle_iteration_state_enum.py | 40 +
authentik_client/models/lifecycle_rule.py | 147 +
.../models/lifecycle_rule_request.py | 115 +
authentik_client/models/link.py | 89 +
authentik_client/models/log_event.py | 99 +
authentik_client/models/log_level_enum.py | 44 +
.../models/login_challenge_types.py | 169 +
authentik_client/models/login_source.py | 104 +
authentik_client/models/logout_url.py | 124 +
authentik_client/models/matching_mode_enum.py | 38 +
authentik_client/models/mdm_config_request.py | 93 +
.../models/mdm_config_response.py | 93 +
authentik_client/models/metadata.py | 91 +
.../models/microsoft_entra_provider.py | 159 +
.../models/microsoft_entra_provider_group.py | 110 +
.../microsoft_entra_provider_group_request.py | 95 +
.../microsoft_entra_provider_mapping.py | 119 +
...icrosoft_entra_provider_mapping_request.py | 99 +
.../microsoft_entra_provider_request.py | 121 +
.../models/microsoft_entra_provider_user.py | 110 +
.../microsoft_entra_provider_user_request.py | 94 +
authentik_client/models/model_enum.py | 158 +
authentik_client/models/model_request.py | 267 +
authentik_client/models/mutual_tls_stage.py | 133 +
.../models/mutual_tls_stage_request.py | 102 +
.../models/native_logout_challenge.py | 129 +
...ative_logout_challenge_response_request.py | 90 +
authentik_client/models/network.py | 103 +
.../models/network_binding_enum.py | 40 +
authentik_client/models/network_interface.py | 95 +
.../models/network_interface_request.py | 96 +
authentik_client/models/network_request.py | 104 +
.../models/not_configured_action_enum.py | 39 +
authentik_client/models/notification.py | 129 +
.../models/notification_request.py | 110 +
authentik_client/models/notification_rule.py | 121 +
.../models/notification_rule_request.py | 105 +
.../models/notification_transport.py | 130 +
.../models/notification_transport_request.py | 123 +
.../models/notification_transport_test.py | 89 +
.../models/notification_webhook_mapping.py | 96 +
.../notification_webhook_mapping_request.py | 92 +
authentik_client/models/o_auth2_provider.py | 219 +
.../o_auth2_provider_logout_method_enum.py | 38 +
.../models/o_auth2_provider_request.py | 163 +
.../models/o_auth2_provider_setup_urls.py | 115 +
.../models/o_auth_device_code_challenge.py | 112 +
..._device_code_challenge_response_request.py | 92 +
.../o_auth_device_code_finish_challenge.py | 112 +
..._code_finish_challenge_response_request.py | 90 +
authentik_client/models/o_auth_source.py | 248 +
.../models/o_auth_source_property_mapping.py | 119 +
.../o_auth_source_property_mapping_request.py | 99 +
.../models/o_auth_source_request.py | 187 +
.../models/open_id_connect_configuration.py | 109 +
authentik_client/models/operating_system.py | 96 +
.../models/operating_system_request.py | 97 +
.../models/outgoing_sync_delete_action.py | 39 +
authentik_client/models/outpost.py | 148 +
.../models/outpost_default_config.py | 91 +
authentik_client/models/outpost_health.py | 141 +
authentik_client/models/outpost_request.py | 112 +
authentik_client/models/outpost_type_enum.py | 40 +
.../paginated_account_lockdown_stage_list.py | 105 +
.../models/paginated_agent_connector_list.py | 105 +
...d_apple_independent_secure_enclave_list.py | 105 +
.../paginated_application_entitlement_list.py | 105 +
.../models/paginated_application_list.py | 105 +
.../paginated_authenticated_session_list.py | 105 +
.../paginated_authenticator_duo_stage_list.py | 105 +
...aginated_authenticator_email_stage_list.py | 105 +
..._authenticator_endpoint_gdtc_stage_list.py | 105 +
.../paginated_authenticator_sms_stage_list.py | 105 +
...ginated_authenticator_static_stage_list.py | 105 +
...paginated_authenticator_totp_stage_list.py | 105 +
...nated_authenticator_validate_stage_list.py | 105 +
...ated_authenticator_web_authn_stage_list.py | 105 +
.../paginated_blueprint_instance_list.py | 105 +
.../models/paginated_brand_list.py | 105 +
.../models/paginated_captcha_stage_list.py | 105 +
.../paginated_certificate_key_pair_list.py | 105 +
.../models/paginated_connection_token_list.py | 105 +
.../models/paginated_connector_list.py | 105 +
.../models/paginated_consent_stage_list.py | 105 +
.../models/paginated_data_export_list.py | 105 +
.../models/paginated_deny_stage_list.py | 105 +
.../paginated_device_access_group_list.py | 105 +
.../paginated_device_user_binding_list.py | 105 +
...aginated_docker_service_connection_list.py | 105 +
.../models/paginated_domain_list.py | 105 +
.../models/paginated_dummy_policy_list.py | 105 +
.../models/paginated_dummy_stage_list.py | 105 +
.../models/paginated_duo_device_list.py | 105 +
.../models/paginated_email_device_list.py | 105 +
.../models/paginated_email_stage_list.py | 105 +
.../models/paginated_endpoint_device_list.py | 105 +
.../models/paginated_endpoint_list.py | 105 +
.../models/paginated_endpoint_stage_list.py | 105 +
.../models/paginated_enrollment_token_list.py | 105 +
.../models/paginated_event_list.py | 105 +
.../paginated_event_matcher_policy_list.py | 105 +
...aginated_expiring_base_grant_model_list.py | 105 +
.../paginated_expression_policy_list.py | 105 +
...nated_extra_role_object_permission_list.py | 105 +
.../models/paginated_fleet_connector_list.py | 105 +
.../models/paginated_flow_list.py | 105 +
.../paginated_flow_stage_binding_list.py | 105 +
.../models/paginated_geo_ip_policy_list.py | 105 +
.../paginated_google_chrome_connector_list.py | 105 +
.../paginated_google_endpoint_device_list.py | 105 +
...ed_google_workspace_provider_group_list.py | 105 +
...aginated_google_workspace_provider_list.py | 105 +
..._google_workspace_provider_mapping_list.py | 105 +
...ted_google_workspace_provider_user_list.py | 105 +
...d_group_kerberos_source_connection_list.py | 105 +
...nated_group_ldap_source_connection_list.py | 105 +
.../models/paginated_group_list.py | 105 +
...ted_group_o_auth_source_connection_list.py | 105 +
...nated_group_plex_source_connection_list.py | 105 +
...nated_group_saml_source_connection_list.py | 105 +
.../paginated_group_source_connection_list.py | 105 +
...d_group_telegram_source_connection_list.py | 105 +
.../paginated_identification_stage_list.py | 105 +
.../paginated_initial_permissions_list.py | 105 +
.../models/paginated_invitation_list.py | 105 +
.../models/paginated_invitation_stage_list.py | 105 +
.../models/paginated_kerberos_source_list.py | 105 +
...d_kerberos_source_property_mapping_list.py | 105 +
...ated_kubernetes_service_connection_list.py | 105 +
.../paginated_ldap_outpost_config_list.py | 105 +
.../models/paginated_ldap_provider_list.py | 105 +
.../models/paginated_ldap_source_list.py | 105 +
...nated_ldap_source_property_mapping_list.py | 105 +
.../models/paginated_license_list.py | 105 +
.../paginated_lifecycle_iteration_list.py | 105 +
.../models/paginated_lifecycle_rule_list.py | 105 +
...ted_microsoft_entra_provider_group_list.py | 105 +
...paginated_microsoft_entra_provider_list.py | 105 +
...d_microsoft_entra_provider_mapping_list.py | 105 +
...ated_microsoft_entra_provider_user_list.py | 105 +
.../models/paginated_mutual_tls_stage_list.py | 105 +
.../models/paginated_notification_list.py | 105 +
.../paginated_notification_rule_list.py | 105 +
.../paginated_notification_transport_list.py | 105 +
...nated_notification_webhook_mapping_list.py | 105 +
.../models/paginated_o_auth2_provider_list.py | 105 +
.../models/paginated_o_auth_source_list.py | 105 +
...ted_o_auth_source_property_mapping_list.py | 105 +
.../models/paginated_outpost_list.py | 105 +
.../paginated_password_expiry_policy_list.py | 105 +
.../models/paginated_password_policy_list.py | 105 +
.../models/paginated_password_stage_list.py | 105 +
.../models/paginated_permission_list.py | 105 +
.../models/paginated_plex_source_list.py | 105 +
...nated_plex_source_property_mapping_list.py | 105 +
.../models/paginated_policy_binding_list.py | 105 +
.../models/paginated_policy_list.py | 105 +
.../models/paginated_prompt_list.py | 105 +
.../models/paginated_prompt_stage_list.py | 105 +
.../models/paginated_property_mapping_list.py | 105 +
.../models/paginated_provider_list.py | 105 +
.../paginated_proxy_outpost_config_list.py | 105 +
.../models/paginated_proxy_provider_list.py | 105 +
.../paginated_rac_property_mapping_list.py | 105 +
.../models/paginated_rac_provider_list.py | 105 +
.../paginated_radius_outpost_config_list.py | 105 +
.../models/paginated_radius_provider_list.py | 105 +
...d_radius_provider_property_mapping_list.py | 105 +
.../models/paginated_redirect_stage_list.py | 105 +
.../models/paginated_reputation_list.py | 105 +
.../paginated_reputation_policy_list.py | 105 +
...ed_role_assigned_object_permission_list.py | 105 +
.../models/paginated_role_list.py | 105 +
.../paginated_saml_property_mapping_list.py | 105 +
.../models/paginated_saml_provider_list.py | 105 +
.../models/paginated_saml_source_list.py | 105 +
...nated_saml_source_property_mapping_list.py | 105 +
.../models/paginated_schedule_list.py | 105 +
.../models/paginated_scim_mapping_list.py | 105 +
.../paginated_scim_provider_group_list.py | 105 +
.../models/paginated_scim_provider_list.py | 105 +
.../paginated_scim_provider_user_list.py | 105 +
.../paginated_scim_source_group_list.py | 105 +
.../models/paginated_scim_source_list.py | 105 +
...nated_scim_source_property_mapping_list.py | 105 +
.../models/paginated_scim_source_user_list.py | 105 +
.../models/paginated_scope_mapping_list.py | 105 +
.../paginated_service_connection_list.py | 105 +
.../models/paginated_sms_device_list.py | 105 +
.../models/paginated_source_list.py | 105 +
.../models/paginated_source_stage_list.py | 105 +
.../models/paginated_ssf_provider_list.py | 105 +
.../models/paginated_ssf_stream_list.py | 105 +
.../models/paginated_stage_list.py | 105 +
.../models/paginated_static_device_list.py | 105 +
.../models/paginated_task_list.py | 105 +
.../models/paginated_telegram_source_list.py | 105 +
...d_telegram_source_property_mapping_list.py | 105 +
.../models/paginated_tenant_list.py | 105 +
.../models/paginated_token_list.py | 105 +
.../models/paginated_token_model_list.py | 105 +
.../models/paginated_totp_device_list.py | 105 +
.../paginated_unique_password_policy_list.py | 105 +
.../models/paginated_user_consent_list.py | 105 +
.../paginated_user_delete_stage_list.py | 105 +
...ed_user_kerberos_source_connection_list.py | 105 +
...inated_user_ldap_source_connection_list.py | 105 +
.../models/paginated_user_list.py | 105 +
.../models/paginated_user_login_stage_list.py | 105 +
.../paginated_user_logout_stage_list.py | 105 +
...ated_user_o_auth_source_connection_list.py | 105 +
...inated_user_plex_source_connection_list.py | 105 +
...inated_user_saml_source_connection_list.py | 105 +
.../paginated_user_source_connection_list.py | 105 +
...ed_user_telegram_source_connection_list.py | 105 +
.../models/paginated_user_write_stage_list.py | 105 +
.../models/paginated_web_authn_device_list.py | 105 +
.../paginated_web_authn_device_type_list.py | 105 +
.../paginated_ws_federation_provider_list.py | 105 +
authentik_client/models/pagination.py | 101 +
authentik_client/models/partial_group.py | 102 +
authentik_client/models/partial_user.py | 124 +
authentik_client/models/password_challenge.py | 120 +
.../password_challenge_response_request.py | 92 +
.../models/password_expiry_policy.py | 121 +
.../models/password_expiry_policy_request.py | 96 +
authentik_client/models/password_policy.py | 143 +
.../models/password_policy_request.py | 118 +
authentik_client/models/password_stage.py | 137 +
.../models/password_stage_request.py | 105 +
.../patched_account_lockdown_stage_request.py | 106 +
.../models/patched_agent_connector_request.py | 127 +
...pple_independent_secure_enclave_request.py | 99 +
...patched_application_entitlement_request.py | 95 +
.../models/patched_application_request.py | 131 +
...patched_authenticator_duo_stage_request.py | 110 +
...tched_authenticator_email_stage_request.py | 124 +
...thenticator_endpoint_gdtc_stage_request.py | 102 +
...patched_authenticator_sms_stage_request.py | 123 +
...ched_authenticator_static_stage_request.py | 104 +
...atched_authenticator_totp_stage_request.py | 103 +
...ed_authenticator_validate_stage_request.py | 117 +
...d_authenticator_web_authn_stage_request.py | 122 +
.../patched_blueprint_instance_request.py | 98 +
.../models/patched_brand_request.py | 170 +
.../models/patched_captcha_stage_request.py | 106 +
.../patched_certificate_key_pair_request.py | 94 +
.../patched_connection_token_request.py | 94 +
.../models/patched_consent_stage_request.py | 95 +
.../models/patched_deny_stage_request.py | 92 +
.../patched_device_access_group_request.py | 92 +
.../patched_device_user_binding_request.py | 124 +
...tched_docker_service_connection_request.py | 109 +
.../models/patched_domain_request.py | 95 +
.../models/patched_dummy_policy_request.py | 98 +
.../models/patched_dummy_stage_request.py | 92 +
.../models/patched_duo_device_request.py | 90 +
.../models/patched_email_device_request.py | 90 +
.../models/patched_email_stage_request.py | 120 +
.../models/patched_endpoint_device_request.py | 118 +
.../models/patched_endpoint_request.py | 107 +
.../models/patched_endpoint_stage_request.py | 96 +
.../patched_enrollment_token_request.py | 110 +
.../patched_event_matcher_policy_request.py | 130 +
.../models/patched_event_request.py | 109 +
.../patched_expression_policy_request.py | 94 +
.../models/patched_fleet_connector_request.py | 110 +
.../models/patched_flow_request.py | 126 +
.../patched_flow_stage_binding_request.py | 105 +
.../models/patched_geo_ip_policy_request.py | 109 +
...patched_google_chrome_connector_request.py | 97 +
.../patched_google_endpoint_device_request.py | 93 +
...ogle_workspace_provider_mapping_request.py | 99 +
...tched_google_workspace_provider_request.py | 123 +
...roup_kerberos_source_connection_request.py | 95 +
...ed_group_ldap_source_connection_request.py | 95 +
..._group_o_auth_source_connection_request.py | 95 +
...ed_group_plex_source_connection_request.py | 95 +
.../models/patched_group_request.py | 101 +
...ed_group_saml_source_connection_request.py | 95 +
...patched_group_source_connection_request.py | 95 +
...roup_telegram_source_connection_request.py | 95 +
.../patched_identification_stage_request.py | 148 +
.../patched_initial_permissions_request.py | 95 +
.../models/patched_invitation_request.py | 123 +
.../patched_invitation_stage_request.py | 92 +
...erberos_source_property_mapping_request.py | 99 +
.../models/patched_kerberos_source_request.py | 171 +
...d_kubernetes_service_connection_request.py | 96 +
.../models/patched_ldap_provider_request.py | 126 +
...ed_ldap_source_property_mapping_request.py | 99 +
.../models/patched_ldap_source_request.py | 200 +
.../models/patched_license_request.py | 90 +
.../models/patched_lifecycle_rule_request.py | 115 +
...icrosoft_entra_provider_mapping_request.py | 99 +
...atched_microsoft_entra_provider_request.py | 121 +
.../patched_mutual_tls_stage_request.py | 102 +
.../models/patched_notification_request.py | 110 +
.../patched_notification_rule_request.py | 105 +
.../patched_notification_transport_request.py | 123 +
...ed_notification_webhook_mapping_request.py | 92 +
.../patched_o_auth2_provider_request.py | 163 +
..._o_auth_source_property_mapping_request.py | 99 +
.../models/patched_o_auth_source_request.py | 190 +
.../models/patched_outpost_request.py | 112 +
.../patched_password_expiry_policy_request.py | 96 +
.../models/patched_password_policy_request.py | 118 +
.../models/patched_password_stage_request.py | 105 +
.../patched_permission_assign_request.py | 95 +
...ed_plex_source_property_mapping_request.py | 99 +
.../models/patched_plex_source_request.py | 149 +
.../models/patched_policy_binding_request.py | 122 +
.../models/patched_prompt_request.py | 111 +
.../models/patched_prompt_stage_request.py | 95 +
.../models/patched_proxy_provider_request.py | 140 +
.../patched_rac_property_mapping_request.py | 101 +
.../models/patched_rac_provider_request.py | 108 +
...adius_provider_property_mapping_request.py | 99 +
.../models/patched_radius_provider_request.py | 117 +
.../models/patched_redirect_stage_request.py | 105 +
.../patched_reputation_policy_request.py | 98 +
.../models/patched_role_request.py | 90 +
.../patched_saml_property_mapping_request.py | 108 +
.../models/patched_saml_provider_request.py | 180 +
...ed_saml_source_property_mapping_request.py | 99 +
.../models/patched_saml_source_request.py | 197 +
.../models/patched_schedule_request.py | 99 +
.../models/patched_scim_mapping_request.py | 99 +
.../models/patched_scim_provider_request.py | 128 +
.../patched_scim_source_group_request.py | 99 +
...ed_scim_source_property_mapping_request.py | 99 +
.../models/patched_scim_source_request.py | 114 +
.../patched_scim_source_user_request.py | 99 +
.../models/patched_scope_mapping_request.py | 103 +
.../models/patched_settings_request.py | 129 +
.../models/patched_settings_request_flags.py | 95 +
.../models/patched_sms_device_request.py | 90 +
.../models/patched_source_stage_request.py | 95 +
.../models/patched_ssf_provider_request.py | 99 +
.../models/patched_static_device_request.py | 90 +
...elegram_source_property_mapping_request.py | 99 +
.../models/patched_telegram_source_request.py | 146 +
.../models/patched_tenant_request.py | 94 +
.../models/patched_token_request.py | 127 +
.../models/patched_totp_device_request.py | 90 +
.../patched_unique_password_policy_request.py | 96 +
.../patched_user_delete_stage_request.py | 90 +
...user_kerberos_source_connection_request.py | 95 +
...hed_user_ldap_source_connection_request.py | 95 +
.../patched_user_login_stage_request.py | 104 +
.../patched_user_logout_stage_request.py | 90 +
...d_user_o_auth_source_connection_request.py | 105 +
...hed_user_plex_source_connection_request.py | 97 +
.../models/patched_user_request.py | 116 +
...hed_user_saml_source_connection_request.py | 95 +
.../patched_user_source_connection_request.py | 95 +
...user_telegram_source_connection_request.py | 95 +
.../patched_user_write_stage_request.py | 108 +
.../patched_web_authn_device_request.py | 90 +
.../patched_ws_federation_provider_request.py | 155 +
authentik_client/models/permission.py | 112 +
.../models/permission_assign_request.py | 95 +
.../models/permission_assign_result.py | 89 +
authentik_client/models/pkce_method_enum.py | 39 +
.../models/plex_authentication_challenge.py | 116 +
...thentication_challenge_response_request.py | 90 +
authentik_client/models/plex_source.py | 192 +
.../models/plex_source_property_mapping.py | 119 +
.../plex_source_property_mapping_request.py | 99 +
.../models/plex_source_request.py | 146 +
.../models/plex_token_redeem_request.py | 90 +
authentik_client/models/policy.py | 116 +
authentik_client/models/policy_binding.py | 165 +
.../models/policy_binding_request.py | 122 +
authentik_client/models/policy_engine_mode.py | 38 +
.../models/policy_test_request.py | 91 +
authentik_client/models/policy_test_result.py | 105 +
authentik_client/models/process.py | 93 +
authentik_client/models/process_request.py | 94 +
authentik_client/models/prompt.py | 128 +
authentik_client/models/prompt_challenge.py | 122 +
.../prompt_challenge_response_request.py | 103 +
authentik_client/models/prompt_choice.py | 91 +
authentik_client/models/prompt_request.py | 111 +
authentik_client/models/prompt_stage.py | 126 +
.../models/prompt_stage_request.py | 95 +
authentik_client/models/prompt_type_enum.py | 57 +
authentik_client/models/property_mapping.py | 119 +
.../models/property_mapping_preview.py | 91 +
.../models/property_mapping_test_request.py | 104 +
.../models/property_mapping_test_result.py | 95 +
authentik_client/models/protocol_enum.py | 39 +
authentik_client/models/provider.py | 159 +
authentik_client/models/provider_enum.py | 38 +
.../models/provider_model_enum.py | 47 +
authentik_client/models/provider_type_enum.py | 53 +
authentik_client/models/proxy_mode.py | 39 +
.../models/proxy_outpost_config.py | 158 +
authentik_client/models/proxy_provider.py | 215 +
.../models/proxy_provider_request.py | 140 +
.../models/rac_property_mapping.py | 121 +
.../models/rac_property_mapping_request.py | 101 +
authentik_client/models/rac_provider.py | 167 +
.../models/rac_provider_request.py | 108 +
.../models/radius_check_access.py | 95 +
.../models/radius_outpost_config.py | 111 +
authentik_client/models/radius_provider.py | 176 +
.../radius_provider_property_mapping.py | 119 +
...adius_provider_property_mapping_request.py | 99 +
.../models/radius_provider_request.py | 117 +
authentik_client/models/redirect_challenge.py | 114 +
.../redirect_challenge_response_request.py | 92 +
authentik_client/models/redirect_stage.py | 136 +
.../models/redirect_stage_mode_enum.py | 38 +
.../models/redirect_stage_request.py | 105 +
authentik_client/models/redirect_uri.py | 95 +
.../models/redirect_uri_request.py | 96 +
.../models/redirect_uri_type_enum.py | 38 +
authentik_client/models/related_group.py | 102 +
authentik_client/models/related_rule.py | 120 +
authentik_client/models/reputation.py | 106 +
authentik_client/models/reputation_policy.py | 123 +
.../models/reputation_policy_request.py | 98 +
authentik_client/models/review.py | 114 +
authentik_client/models/review_request.py | 98 +
authentik_client/models/reviewer_group.py | 94 +
authentik_client/models/reviewer_user.py | 111 +
authentik_client/models/role.py | 94 +
.../models/role_assigned_object_permission.py | 115 +
.../models/role_model_permission.py | 107 +
.../models/role_object_permission.py | 109 +
authentik_client/models/role_request.py | 90 +
authentik_client/models/saml_bindings_enum.py | 38 +
.../models/saml_logout_methods.py | 39 +
authentik_client/models/saml_metadata.py | 96 +
.../models/saml_name_id_policy_enum.py | 42 +
.../models/saml_property_mapping.py | 128 +
.../models/saml_property_mapping_request.py | 108 +
authentik_client/models/saml_provider.py | 271 +
.../models/saml_provider_request.py | 180 +
authentik_client/models/saml_source.py | 240 +
.../models/saml_source_property_mapping.py | 119 +
.../saml_source_property_mapping_request.py | 99 +
.../models/saml_source_request.py | 194 +
authentik_client/models/schedule.py | 152 +
authentik_client/models/schedule_request.py | 99 +
.../models/scim_authentication_mode_enum.py | 38 +
authentik_client/models/scim_mapping.py | 119 +
.../models/scim_mapping_request.py | 99 +
authentik_client/models/scim_provider.py | 166 +
.../models/scim_provider_group.py | 110 +
.../models/scim_provider_group_request.py | 95 +
.../models/scim_provider_request.py | 128 +
authentik_client/models/scim_provider_user.py | 110 +
.../models/scim_provider_user_request.py | 94 +
authentik_client/models/scim_source.py | 152 +
authentik_client/models/scim_source_group.py | 106 +
.../models/scim_source_group_request.py | 99 +
.../models/scim_source_property_mapping.py | 119 +
.../scim_source_property_mapping_request.py | 99 +
.../models/scim_source_request.py | 111 +
authentik_client/models/scim_source_user.py | 106 +
.../models/scim_source_user_request.py | 99 +
authentik_client/models/scope_mapping.py | 123 +
.../models/scope_mapping_request.py | 103 +
authentik_client/models/selectable_stage.py | 96 +
authentik_client/models/service_connection.py | 112 +
.../models/service_connection_state.py | 95 +
.../models/session_end_challenge.py | 124 +
authentik_client/models/session_user.py | 98 +
authentik_client/models/settings.py | 129 +
authentik_client/models/settings_request.py | 129 +
authentik_client/models/severity_enum.py | 39 +
authentik_client/models/shell_challenge.py | 114 +
.../models/signature_algorithm_enum.py | 45 +
authentik_client/models/sms_device.py | 106 +
authentik_client/models/sms_device_request.py | 90 +
authentik_client/models/software.py | 95 +
authentik_client/models/software_request.py | 96 +
authentik_client/models/source.py | 186 +
authentik_client/models/source_stage.py | 126 +
.../models/source_stage_request.py | 95 +
authentik_client/models/source_type.py | 147 +
authentik_client/models/ssf_provider.py | 147 +
.../models/ssf_provider_request.py | 99 +
authentik_client/models/ssf_stream.py | 124 +
.../models/ssf_stream_status_enum.py | 40 +
authentik_client/models/stage.py | 122 +
authentik_client/models/stage_mode_enum.py | 38 +
authentik_client/models/stage_prompt.py | 119 +
authentik_client/models/static_device.py | 114 +
.../models/static_device_request.py | 90 +
.../models/static_device_token.py | 90 +
authentik_client/models/sub_mode_enum.py | 42 +
.../models/sync_object_model_enum.py | 38 +
.../models/sync_object_request.py | 95 +
authentik_client/models/sync_object_result.py | 99 +
.../models/sync_outgoing_trigger_mode_enum.py | 39 +
authentik_client/models/sync_status.py | 95 +
authentik_client/models/system_info.py | 122 +
.../models/system_info_runtime.py | 108 +
authentik_client/models/task.py | 164 +
.../models/task_aggregated_status_enum.py | 46 +
authentik_client/models/task_status_enum.py | 43 +
.../models/telegram_auth_request.py | 102 +
.../telegram_challenge_response_request.py | 104 +
.../models/telegram_login_challenge.py | 116 +
authentik_client/models/telegram_source.py | 192 +
.../telegram_source_property_mapping.py | 119 +
...elegram_source_property_mapping_request.py | 99 +
.../models/telegram_source_request.py | 143 +
authentik_client/models/tenant.py | 99 +
.../tenant_admin_group_request_request.py | 90 +
.../tenant_recovery_key_request_request.py | 92 +
.../models/tenant_recovery_key_response.py | 92 +
authentik_client/models/tenant_request.py | 94 +
authentik_client/models/themed_urls.py | 101 +
authentik_client/models/token.py | 137 +
authentik_client/models/token_model.py | 123 +
authentik_client/models/token_request.py | 124 +
.../models/token_set_key_request.py | 90 +
authentik_client/models/token_view.py | 91 +
authentik_client/models/totp_device.py | 102 +
.../models/totp_device_request.py | 90 +
.../models/transaction_application_request.py | 112 +
.../transaction_application_response.py | 91 +
.../transaction_policy_binding_request.py | 120 +
.../models/transport_mode_enum.py | 40 +
authentik_client/models/type_create.py | 101 +
authentik_client/models/ui_theme_enum.py | 39 +
.../models/unique_password_policy.py | 121 +
.../models/unique_password_policy_request.py | 96 +
authentik_client/models/usage_enum.py | 37 +
authentik_client/models/used_by.py | 98 +
.../models/used_by_action_enum.py | 41 +
authentik_client/models/user.py | 182 +
.../models/user_account_lockdown_request.py | 94 +
.../models/user_account_request.py | 89 +
...ser_account_serializer_for_role_request.py | 89 +
.../models/user_attribute_enum.py | 38 +
authentik_client/models/user_consent.py | 115 +
.../models/user_creation_mode_enum.py | 39 +
authentik_client/models/user_delete_stage.py | 122 +
.../models/user_delete_stage_request.py | 90 +
authentik_client/models/user_fields_enum.py | 39 +
.../models/user_kerberos_source_connection.py | 115 +
...user_kerberos_source_connection_request.py | 95 +
.../models/user_ldap_source_connection.py | 123 +
.../user_ldap_source_connection_request.py | 95 +
.../models/user_login_challenge.py | 116 +
.../user_login_challenge_response_request.py | 92 +
authentik_client/models/user_login_stage.py | 136 +
.../models/user_login_stage_request.py | 104 +
authentik_client/models/user_logout_stage.py | 122 +
.../models/user_logout_stage_request.py | 90 +
.../models/user_matching_mode_enum.py | 41 +
.../models/user_o_auth_source_connection.py | 117 +
.../user_o_auth_source_connection_request.py | 105 +
.../models/user_password_hash_set_request.py | 90 +
.../models/user_password_set_request.py | 90 +
authentik_client/models/user_path.py | 91 +
.../models/user_plex_source_connection.py | 115 +
.../user_plex_source_connection_request.py | 97 +
.../models/user_recovery_email_request.py | 93 +
.../models/user_recovery_link_request.py | 90 +
authentik_client/models/user_request.py | 116 +
.../models/user_saml_source_connection.py | 115 +
.../user_saml_source_connection_request.py | 95 +
authentik_client/models/user_self.py | 159 +
authentik_client/models/user_self_groups.py | 95 +
authentik_client/models/user_self_roles.py | 95 +
.../models/user_service_account_request.py | 97 +
.../models/user_service_account_response.py | 97 +
authentik_client/models/user_setting.py | 97 +
.../models/user_source_connection.py | 115 +
.../models/user_source_connection_request.py | 95 +
.../models/user_telegram_source_connection.py | 115 +
...user_telegram_source_connection_request.py | 95 +
authentik_client/models/user_type_enum.py | 40 +
.../models/user_verification_enum.py | 39 +
authentik_client/models/user_write_stage.py | 139 +
.../models/user_write_stage_request.py | 108 +
authentik_client/models/validation_error.py | 104 +
authentik_client/models/vendor_enum.py | 40 +
authentik_client/models/version.py | 111 +
authentik_client/models/version_history.py | 98 +
authentik_client/models/web_authn_device.py | 124 +
.../models/web_authn_device_request.py | 90 +
.../models/web_authn_device_type.py | 92 +
.../models/web_authn_hint_enum.py | 39 +
authentik_client/models/worker.py | 93 +
.../models/ws_federation_provider.py | 218 +
.../models/ws_federation_provider_request.py | 155 +
authentik_client/py.typed | 0
authentik_client/rest.py | 264 +
docs/AccessDeniedChallenge.md | 35 +
docs/AccountLockdownStage.md | 41 +
docs/AccountLockdownStageRequest.md | 35 +
docs/AdminApi.md | 1086 +
docs/AgentAuthenticationResponse.md | 30 +
docs/AgentConfig.md | 39 +
docs/AgentConnector.md | 46 +
docs/AgentConnectorRequest.md | 42 +
docs/AgentPSSODeviceRegistrationRequest.md | 33 +
docs/AgentPSSODeviceRegistrationResponse.md | 35 +
docs/AgentPSSOUserRegistrationRequest.md | 32 +
docs/AgentTokenResponse.md | 31 +
docs/AlgEnum.md | 16 +
docs/App.md | 31 +
docs/AppEnum.md | 168 +
docs/AppleChallengeResponseRequest.md | 30 +
docs/AppleIndependentSecureEnclave.md | 33 +
docs/AppleIndependentSecureEnclaveRequest.md | 33 +
docs/AppleLoginChallenge.md | 36 +
docs/Application.md | 47 +
docs/ApplicationEntitlement.md | 33 +
docs/ApplicationEntitlementRequest.md | 32 +
docs/ApplicationRequest.md | 41 +
docs/AuthTypeEnum.md | 12 +
docs/AuthenticatedSession.md | 39 +
docs/AuthenticatedSessionAsn.md | 32 +
docs/AuthenticatedSessionGeoIp.md | 34 +
docs/AuthenticatedSessionUserAgent.md | 33 +
docs/AuthenticatedSessionUserAgentDevice.md | 32 +
docs/AuthenticatedSessionUserAgentOs.md | 34 +
.../AuthenticatedSessionUserAgentUserAgent.md | 33 +
docs/AuthenticationEnum.md | 22 +
docs/AuthenticatorAttachmentEnum.md | 12 +
docs/AuthenticatorDuoChallenge.md | 37 +
...uthenticatorDuoChallengeResponseRequest.md | 30 +
docs/AuthenticatorDuoStage.md | 41 +
...thenticatorDuoStageDeviceImportResponse.md | 30 +
...icatorDuoStageManualDeviceImportRequest.md | 30 +
docs/AuthenticatorDuoStageRequest.md | 37 +
docs/AuthenticatorEmailChallenge.md | 36 +
...henticatorEmailChallengeResponseRequest.md | 32 +
docs/AuthenticatorEmailStage.md | 50 +
docs/AuthenticatorEmailStageRequest.md | 44 +
docs/AuthenticatorEndpointGDTCStage.md | 39 +
docs/AuthenticatorEndpointGDTCStageRequest.md | 33 +
docs/AuthenticatorSMSChallenge.md | 35 +
...uthenticatorSMSChallengeResponseRequest.md | 32 +
docs/AuthenticatorSMSStage.md | 46 +
docs/AuthenticatorSMSStageRequest.md | 40 +
docs/AuthenticatorStaticChallenge.md | 35 +
...enticatorStaticChallengeResponseRequest.md | 30 +
docs/AuthenticatorStaticStage.md | 40 +
docs/AuthenticatorStaticStageRequest.md | 34 +
docs/AuthenticatorTOTPChallenge.md | 35 +
...thenticatorTOTPChallengeResponseRequest.md | 31 +
docs/AuthenticatorTOTPStage.md | 39 +
docs/AuthenticatorTOTPStageRequest.md | 33 +
docs/AuthenticatorValidateStage.md | 48 +
docs/AuthenticatorValidateStageRequest.md | 41 +
docs/AuthenticatorValidationChallenge.md | 36 +
...catorValidationChallengeResponseRequest.md | 35 +
docs/AuthenticatorWebAuthnChallenge.md | 35 +
...ticatorWebAuthnChallengeResponseRequest.md | 31 +
docs/AuthenticatorWebAuthnStage.md | 46 +
docs/AuthenticatorWebAuthnStageRequest.md | 39 +
docs/AuthenticatorsApi.md | 6636 ++
docs/AuthorizationCodeAuthMethodEnum.md | 12 +
docs/AutoSubmitChallengeResponseRequest.md | 30 +
docs/AutosubmitChallenge.md | 35 +
docs/BackendsEnum.md | 16 +
docs/BindingTypeEnum.md | 14 +
docs/BlueprintFile.md | 32 +
docs/BlueprintImportResult.md | 31 +
docs/BlueprintInstance.md | 40 +
docs/BlueprintInstanceRequest.md | 34 +
docs/BlueprintInstanceStatusEnum.md | 18 +
docs/Brand.md | 48 +
docs/BrandRequest.md | 47 +
docs/BulkDeleteSessionResponse.md | 29 +
docs/Cache.md | 30 +
docs/CapabilitiesEnum.md | 22 +
docs/CaptchaChallenge.md | 37 +
docs/CaptchaChallengeResponseRequest.md | 31 +
docs/CaptchaStage.md | 43 +
docs/CaptchaStageRequest.md | 38 +
docs/CertAttributeEnum.md | 14 +
docs/CertificateData.md | 30 +
docs/CertificateGenerationRequest.md | 33 +
docs/CertificateKeyPair.md | 40 +
docs/CertificateKeyPairKeyTypeEnum.md | 18 +
docs/CertificateKeyPairRequest.md | 32 +
docs/ChallengeTypes.md | 102 +
docs/ClientTypeEnum.md | 12 +
docs/CompatibilityModeEnum.md | 20 +
docs/Config.md | 34 +
docs/ConnectionToken.md | 35 +
docs/ConnectionTokenRequest.md | 32 +
docs/Connector.md | 35 +
docs/ConsentChallenge.md | 38 +
docs/ConsentChallengeResponseRequest.md | 31 +
docs/ConsentModeEnum.md | 14 +
docs/ConsentPermission.md | 31 +
docs/ConsentStage.md | 38 +
docs/ConsentStageRequest.md | 32 +
docs/ContentType.md | 32 +
docs/ContentTypeEnum.md | 14 +
docs/ContextualFlowInfo.md | 34 +
docs/ContextualFlowInfoLayoutEnum.md | 22 +
docs/CoreApi.md | 5675 ++
docs/CountryCodeEnum.md | 506 +
docs/CryptoApi.md | 812 +
docs/CurrentBrand.md | 47 +
docs/CurrentBrandFlags.md | 32 +
docs/DataExport.md | 36 +
docs/DeliveryMethodEnum.md | 16 +
docs/DeniedActionEnum.md | 14 +
docs/DenyStage.md | 37 +
docs/DenyStageRequest.md | 31 +
docs/DetailedCountry.md | 30 +
docs/Device.md | 41 +
docs/DeviceAccessGroup.md | 31 +
docs/DeviceAccessGroupRequest.md | 30 +
docs/DeviceChallenge.md | 33 +
docs/DeviceChallengeRequest.md | 33 +
docs/DeviceClassesEnum.md | 20 +
docs/DeviceConnection.md | 32 +
docs/DeviceFactSnapshot.md | 33 +
docs/DeviceFacts.md | 37 +
docs/DeviceFactsOSFamily.md | 24 +
docs/DeviceFactsRequest.md | 37 +
docs/DeviceGroup.md | 30 +
docs/DeviceGroupRequest.md | 30 +
docs/DeviceSummary.md | 32 +
docs/DeviceUser.md | 32 +
docs/DeviceUserBinding.md | 45 +
docs/DeviceUserBindingRequest.md | 39 +
docs/DeviceUserRequest.md | 32 +
docs/DigestAlgorithmEnum.md | 16 +
docs/DigitsEnum.md | 12 +
docs/Disk.md | 34 +
docs/DiskRequest.md | 34 +
docs/DockerServiceConnection.md | 39 +
docs/DockerServiceConnectionRequest.md | 34 +
docs/Domain.md | 33 +
docs/DomainRequest.md | 32 +
docs/DummyChallenge.md | 33 +
docs/DummyChallengeResponseRequest.md | 30 +
docs/DummyPolicy.md | 40 +
docs/DummyPolicyRequest.md | 34 +
docs/DummyStage.md | 37 +
docs/DummyStageRequest.md | 31 +
docs/DuoDevice.md | 32 +
docs/DuoDeviceEnrollmentStatus.md | 29 +
docs/DuoDeviceRequest.md | 30 +
docs/DuoResponseEnum.md | 14 +
docs/EmailChallenge.md | 32 +
docs/EmailChallengeResponseRequest.md | 30 +
docs/EmailDevice.md | 33 +
docs/EmailDeviceRequest.md | 30 +
docs/EmailStage.md | 50 +
docs/EmailStageRequest.md | 45 +
docs/Endpoint.md | 40 +
docs/EndpointAgentChallenge.md | 34 +
docs/EndpointAgentChallengeResponseRequest.md | 31 +
docs/EndpointAuthModeEnum.md | 12 +
docs/EndpointDevice.md | 37 +
docs/EndpointDeviceDetails.md | 40 +
docs/EndpointDeviceRequest.md | 35 +
docs/EndpointRequest.md | 37 +
docs/EndpointStage.md | 39 +
docs/EndpointStageRequest.md | 32 +
docs/EndpointsApi.md | 5504 ++
docs/EnrollRequest.md | 31 +
docs/EnrollmentToken.md | 35 +
docs/EnrollmentTokenRequest.md | 33 +
docs/EnterpriseApi.md | 792 +
docs/ErrorDetail.md | 31 +
docs/ErrorReportingConfig.md | 34 +
docs/Event.md | 38 +
docs/EventActions.md | 74 +
docs/EventMatcherPolicy.md | 42 +
docs/EventMatcherPolicyRequest.md | 36 +
docs/EventRequest.md | 36 +
docs/EventStats.md | 31 +
docs/EventTopPerUser.md | 32 +
docs/EventVolume.md | 32 +
docs/EventsApi.md | 2740 +
docs/EventsRequestedEnum.md | 26 +
docs/ExpiringBaseGrantModel.md | 35 +
docs/ExpressionPolicy.md | 38 +
docs/ExpressionPolicyRequest.md | 32 +
docs/ExtraRoleObjectPermission.md | 38 +
docs/FileList.md | 33 +
docs/FleetConnector.md | 40 +
docs/FleetConnectorRequest.md | 37 +
docs/Flow.md | 47 +
docs/FlowChallengeResponseRequest.md | 51 +
docs/FlowDesignationEnum.md | 22 +
docs/FlowDiagram.md | 30 +
docs/FlowErrorChallenge.md | 35 +
docs/FlowInspection.md | 32 +
docs/FlowInspectorPlan.md | 33 +
docs/FlowLayoutEnum.md | 22 +
docs/FlowRequest.md | 39 +
docs/FlowSet.md | 41 +
docs/FlowStageBinding.md | 39 +
docs/FlowStageBindingRequest.md | 36 +
docs/FlowsApi.md | 1770 +
docs/FooterLink.md | 31 +
docs/ForceBindingEnum.md | 12 +
docs/FormatEnum.md | 12 +
docs/FrameChallenge.md | 35 +
docs/FrameChallengeResponseRequest.md | 30 +
docs/GenericError.md | 31 +
docs/GeoIPPolicy.md | 46 +
docs/GeoIPPolicyCountriesObjInner.md | 30 +
docs/GeoIPPolicyRequest.md | 39 +
docs/GeoipBindingEnum.md | 16 +
docs/GlobalTaskStatus.md | 38 +
docs/GoogleChromeConnector.md | 38 +
docs/GoogleChromeConnectorRequest.md | 33 +
docs/GoogleEndpointDevice.md | 31 +
docs/GoogleEndpointDeviceRequest.md | 31 +
docs/GoogleWorkspaceProvider.md | 50 +
docs/GoogleWorkspaceProviderGroup.md | 35 +
docs/GoogleWorkspaceProviderGroupRequest.md | 32 +
docs/GoogleWorkspaceProviderMapping.md | 37 +
docs/GoogleWorkspaceProviderMappingRequest.md | 32 +
docs/GoogleWorkspaceProviderRequest.md | 43 +
docs/GoogleWorkspaceProviderUser.md | 35 +
docs/GoogleWorkspaceProviderUserRequest.md | 32 +
docs/GrantTypesEnum.md | 22 +
docs/Group.md | 43 +
docs/GroupKerberosSourceConnection.md | 36 +
docs/GroupKerberosSourceConnectionRequest.md | 32 +
docs/GroupLDAPSourceConnection.md | 37 +
docs/GroupLDAPSourceConnectionRequest.md | 32 +
docs/GroupMatchingModeEnum.md | 14 +
docs/GroupOAuthSourceConnection.md | 36 +
docs/GroupOAuthSourceConnectionRequest.md | 32 +
docs/GroupPlexSourceConnection.md | 36 +
docs/GroupPlexSourceConnectionRequest.md | 32 +
docs/GroupRequest.md | 35 +
docs/GroupSAMLSourceConnection.md | 36 +
docs/GroupSAMLSourceConnectionRequest.md | 32 +
docs/GroupSourceConnection.md | 36 +
docs/GroupSourceConnectionRequest.md | 32 +
docs/GroupTelegramSourceConnection.md | 36 +
docs/GroupTelegramSourceConnectionRequest.md | 32 +
docs/Hardware.md | 34 +
docs/HardwareRequest.md | 34 +
docs/IdentificationChallenge.md | 48 +
.../IdentificationChallengeResponseRequest.md | 34 +
docs/IdentificationStage.md | 49 +
docs/IdentificationStageRequest.md | 43 +
docs/IframeLogoutChallenge.md | 33 +
docs/IframeLogoutChallengeResponseRequest.md | 30 +
docs/ImpersonationRequest.md | 29 +
docs/InitialPermissions.md | 34 +
docs/InitialPermissionsRequest.md | 32 +
docs/InstallID.md | 29 +
docs/IntentEnum.md | 16 +
docs/InvalidResponseActionEnum.md | 14 +
docs/Invitation.md | 37 +
docs/InvitationRequest.md | 34 +
docs/InvitationSendEmailRequest.md | 33 +
docs/InvitationStage.md | 37 +
docs/InvitationStageRequest.md | 31 +
docs/IssuerModeEnum.md | 12 +
docs/KadminTypeEnum.md | 12 +
docs/KerberosSource.md | 62 +
docs/KerberosSourcePropertyMapping.md | 37 +
docs/KerberosSourcePropertyMappingRequest.md | 32 +
docs/KerberosSourceRequest.md | 56 +
docs/KeyTypeEnum.md | 18 +
docs/KubernetesServiceConnection.md | 38 +
docs/KubernetesServiceConnectionRequest.md | 33 +
docs/LDAPAPIAccessMode.md | 12 +
docs/LDAPCheckAccess.md | 31 +
docs/LDAPDebug.md | 31 +
docs/LDAPOutpostConfig.md | 42 +
docs/LDAPProvider.md | 52 +
docs/LDAPProviderRequest.md | 42 +
docs/LDAPSource.md | 72 +
docs/LDAPSourcePropertyMapping.md | 37 +
docs/LDAPSourcePropertyMappingRequest.md | 32 +
docs/LDAPSourceRequest.md | 64 +
docs/LangEnum.md | 206 +
docs/LastTaskStatusEnum.md | 28 +
docs/License.md | 35 +
docs/LicenseFlagsEnum.md | 12 +
docs/LicenseForecast.md | 33 +
docs/LicenseRequest.md | 30 +
docs/LicenseStatusEnum.md | 22 +
docs/LicenseSummary.md | 34 +
docs/LicenseSummaryStatusEnum.md | 22 +
docs/LifecycleApi.md | 810 +
docs/LifecycleIteration.md | 41 +
docs/LifecycleIterationRequest.md | 30 +
docs/LifecycleIterationStateEnum.md | 16 +
docs/LifecycleRule.md | 43 +
docs/LifecycleRuleRequest.md | 39 +
docs/Link.md | 30 +
docs/LogEvent.md | 34 +
docs/LogLevelEnum.md | 24 +
docs/LoginChallengeTypes.md | 39 +
docs/LoginSource.md | 33 +
docs/LogoutURL.md | 35 +
docs/MDMConfigRequest.md | 31 +
docs/MDMConfigResponse.md | 32 +
docs/ManagedApi.md | 802 +
docs/MatchingModeEnum.md | 12 +
docs/Metadata.md | 31 +
docs/MicrosoftEntraProvider.md | 49 +
docs/MicrosoftEntraProviderGroup.md | 35 +
docs/MicrosoftEntraProviderGroupRequest.md | 32 +
docs/MicrosoftEntraProviderMapping.md | 37 +
docs/MicrosoftEntraProviderMappingRequest.md | 32 +
docs/MicrosoftEntraProviderRequest.md | 42 +
docs/MicrosoftEntraProviderUser.md | 35 +
docs/MicrosoftEntraProviderUserRequest.md | 32 +
docs/ModelEnum.md | 252 +
docs/ModelRequest.md | 123 +
docs/MutualTLSStage.md | 40 +
docs/MutualTLSStageRequest.md | 34 +
docs/NativeLogoutChallenge.md | 40 +
docs/NativeLogoutChallengeResponseRequest.md | 30 +
docs/Network.md | 32 +
docs/NetworkBindingEnum.md | 16 +
docs/NetworkInterface.md | 32 +
docs/NetworkInterfaceRequest.md | 32 +
docs/NetworkRequest.md | 32 +
docs/NotConfiguredActionEnum.md | 14 +
docs/Notification.md | 37 +
docs/NotificationRequest.md | 33 +
docs/NotificationRule.md | 36 +
docs/NotificationRuleRequest.md | 34 +
docs/NotificationTransport.md | 40 +
docs/NotificationTransportRequest.md | 38 +
docs/NotificationTransportTest.md | 30 +
docs/NotificationWebhookMapping.md | 32 +
docs/NotificationWebhookMappingRequest.md | 31 +
docs/OAuth2Provider.md | 61 +
docs/OAuth2ProviderLogoutMethodEnum.md | 12 +
docs/OAuth2ProviderRequest.md | 52 +
docs/OAuth2ProviderSetupURLs.md | 36 +
docs/OAuthDeviceCodeChallenge.md | 32 +
...OAuthDeviceCodeChallengeResponseRequest.md | 31 +
docs/OAuthDeviceCodeFinishChallenge.md | 32 +
...eviceCodeFinishChallengeResponseRequest.md | 30 +
docs/OAuthSource.md | 64 +
docs/OAuthSourcePropertyMapping.md | 37 +
docs/OAuthSourcePropertyMappingRequest.md | 32 +
docs/OAuthSourceRequest.md | 55 +
docs/Oauth2Api.md | 965 +
docs/OpenIDConnectConfiguration.md | 40 +
docs/OperatingSystem.md | 33 +
docs/OperatingSystemRequest.md | 33 +
docs/OutgoingSyncDeleteAction.md | 14 +
docs/Outpost.md | 40 +
docs/OutpostDefaultConfig.md | 30 +
docs/OutpostHealth.md | 41 +
docs/OutpostRequest.md | 35 +
docs/OutpostTypeEnum.md | 16 +
docs/OutpostsApi.md | 2765 +
docs/PKCEMethodEnum.md | 14 +
docs/PaginatedAccountLockdownStageList.md | 31 +
docs/PaginatedAgentConnectorList.md | 31 +
...inatedAppleIndependentSecureEnclaveList.md | 31 +
docs/PaginatedApplicationEntitlementList.md | 31 +
docs/PaginatedApplicationList.md | 31 +
docs/PaginatedAuthenticatedSessionList.md | 31 +
docs/PaginatedAuthenticatorDuoStageList.md | 31 +
docs/PaginatedAuthenticatorEmailStageList.md | 31 +
...natedAuthenticatorEndpointGDTCStageList.md | 31 +
docs/PaginatedAuthenticatorSMSStageList.md | 31 +
docs/PaginatedAuthenticatorStaticStageList.md | 31 +
docs/PaginatedAuthenticatorTOTPStageList.md | 31 +
...PaginatedAuthenticatorValidateStageList.md | 31 +
...PaginatedAuthenticatorWebAuthnStageList.md | 31 +
docs/PaginatedBlueprintInstanceList.md | 31 +
docs/PaginatedBrandList.md | 31 +
docs/PaginatedCaptchaStageList.md | 31 +
docs/PaginatedCertificateKeyPairList.md | 31 +
docs/PaginatedConnectionTokenList.md | 31 +
docs/PaginatedConnectorList.md | 31 +
docs/PaginatedConsentStageList.md | 31 +
docs/PaginatedDataExportList.md | 31 +
docs/PaginatedDenyStageList.md | 31 +
docs/PaginatedDeviceAccessGroupList.md | 31 +
docs/PaginatedDeviceUserBindingList.md | 31 +
docs/PaginatedDockerServiceConnectionList.md | 31 +
docs/PaginatedDomainList.md | 31 +
docs/PaginatedDummyPolicyList.md | 31 +
docs/PaginatedDummyStageList.md | 31 +
docs/PaginatedDuoDeviceList.md | 31 +
docs/PaginatedEmailDeviceList.md | 31 +
docs/PaginatedEmailStageList.md | 31 +
docs/PaginatedEndpointDeviceList.md | 31 +
docs/PaginatedEndpointList.md | 31 +
docs/PaginatedEndpointStageList.md | 31 +
docs/PaginatedEnrollmentTokenList.md | 31 +
docs/PaginatedEventList.md | 31 +
docs/PaginatedEventMatcherPolicyList.md | 31 +
docs/PaginatedExpiringBaseGrantModelList.md | 31 +
docs/PaginatedExpressionPolicyList.md | 31 +
.../PaginatedExtraRoleObjectPermissionList.md | 31 +
docs/PaginatedFleetConnectorList.md | 31 +
docs/PaginatedFlowList.md | 31 +
docs/PaginatedFlowStageBindingList.md | 31 +
docs/PaginatedGeoIPPolicyList.md | 31 +
docs/PaginatedGoogleChromeConnectorList.md | 31 +
docs/PaginatedGoogleEndpointDeviceList.md | 31 +
...ginatedGoogleWorkspaceProviderGroupList.md | 31 +
docs/PaginatedGoogleWorkspaceProviderList.md | 31 +
...natedGoogleWorkspaceProviderMappingList.md | 31 +
...aginatedGoogleWorkspaceProviderUserList.md | 31 +
...inatedGroupKerberosSourceConnectionList.md | 31 +
.../PaginatedGroupLDAPSourceConnectionList.md | 31 +
docs/PaginatedGroupList.md | 31 +
...PaginatedGroupOAuthSourceConnectionList.md | 31 +
.../PaginatedGroupPlexSourceConnectionList.md | 31 +
.../PaginatedGroupSAMLSourceConnectionList.md | 31 +
docs/PaginatedGroupSourceConnectionList.md | 31 +
...inatedGroupTelegramSourceConnectionList.md | 31 +
docs/PaginatedIdentificationStageList.md | 31 +
docs/PaginatedInitialPermissionsList.md | 31 +
docs/PaginatedInvitationList.md | 31 +
docs/PaginatedInvitationStageList.md | 31 +
docs/PaginatedKerberosSourceList.md | 31 +
...inatedKerberosSourcePropertyMappingList.md | 31 +
...aginatedKubernetesServiceConnectionList.md | 31 +
docs/PaginatedLDAPOutpostConfigList.md | 31 +
docs/PaginatedLDAPProviderList.md | 31 +
docs/PaginatedLDAPSourceList.md | 31 +
.../PaginatedLDAPSourcePropertyMappingList.md | 31 +
docs/PaginatedLicenseList.md | 31 +
docs/PaginatedLifecycleIterationList.md | 31 +
docs/PaginatedLifecycleRuleList.md | 31 +
...aginatedMicrosoftEntraProviderGroupList.md | 31 +
docs/PaginatedMicrosoftEntraProviderList.md | 31 +
...inatedMicrosoftEntraProviderMappingList.md | 31 +
...PaginatedMicrosoftEntraProviderUserList.md | 31 +
docs/PaginatedMutualTLSStageList.md | 31 +
docs/PaginatedNotificationList.md | 31 +
docs/PaginatedNotificationRuleList.md | 31 +
docs/PaginatedNotificationTransportList.md | 31 +
...PaginatedNotificationWebhookMappingList.md | 31 +
docs/PaginatedOAuth2ProviderList.md | 31 +
docs/PaginatedOAuthSourceList.md | 31 +
...PaginatedOAuthSourcePropertyMappingList.md | 31 +
docs/PaginatedOutpostList.md | 31 +
docs/PaginatedPasswordExpiryPolicyList.md | 31 +
docs/PaginatedPasswordPolicyList.md | 31 +
docs/PaginatedPasswordStageList.md | 31 +
docs/PaginatedPermissionList.md | 31 +
docs/PaginatedPlexSourceList.md | 31 +
.../PaginatedPlexSourcePropertyMappingList.md | 31 +
docs/PaginatedPolicyBindingList.md | 31 +
docs/PaginatedPolicyList.md | 31 +
docs/PaginatedPromptList.md | 31 +
docs/PaginatedPromptStageList.md | 31 +
docs/PaginatedPropertyMappingList.md | 31 +
docs/PaginatedProviderList.md | 31 +
docs/PaginatedProxyOutpostConfigList.md | 31 +
docs/PaginatedProxyProviderList.md | 31 +
docs/PaginatedRACPropertyMappingList.md | 31 +
docs/PaginatedRACProviderList.md | 31 +
docs/PaginatedRadiusOutpostConfigList.md | 31 +
docs/PaginatedRadiusProviderList.md | 31 +
...inatedRadiusProviderPropertyMappingList.md | 31 +
docs/PaginatedRedirectStageList.md | 31 +
docs/PaginatedReputationList.md | 31 +
docs/PaginatedReputationPolicyList.md | 31 +
...ginatedRoleAssignedObjectPermissionList.md | 31 +
docs/PaginatedRoleList.md | 31 +
docs/PaginatedSAMLPropertyMappingList.md | 31 +
docs/PaginatedSAMLProviderList.md | 31 +
docs/PaginatedSAMLSourceList.md | 31 +
.../PaginatedSAMLSourcePropertyMappingList.md | 31 +
docs/PaginatedSCIMMappingList.md | 31 +
docs/PaginatedSCIMProviderGroupList.md | 31 +
docs/PaginatedSCIMProviderList.md | 31 +
docs/PaginatedSCIMProviderUserList.md | 31 +
docs/PaginatedSCIMSourceGroupList.md | 31 +
docs/PaginatedSCIMSourceList.md | 31 +
.../PaginatedSCIMSourcePropertyMappingList.md | 31 +
docs/PaginatedSCIMSourceUserList.md | 31 +
docs/PaginatedSMSDeviceList.md | 31 +
docs/PaginatedSSFProviderList.md | 31 +
docs/PaginatedSSFStreamList.md | 31 +
docs/PaginatedScheduleList.md | 31 +
docs/PaginatedScopeMappingList.md | 31 +
docs/PaginatedServiceConnectionList.md | 31 +
docs/PaginatedSourceList.md | 31 +
docs/PaginatedSourceStageList.md | 31 +
docs/PaginatedStageList.md | 31 +
docs/PaginatedStaticDeviceList.md | 31 +
docs/PaginatedTOTPDeviceList.md | 31 +
docs/PaginatedTaskList.md | 31 +
docs/PaginatedTelegramSourceList.md | 31 +
...inatedTelegramSourcePropertyMappingList.md | 31 +
docs/PaginatedTenantList.md | 31 +
docs/PaginatedTokenList.md | 31 +
docs/PaginatedTokenModelList.md | 31 +
docs/PaginatedUniquePasswordPolicyList.md | 31 +
docs/PaginatedUserConsentList.md | 31 +
docs/PaginatedUserDeleteStageList.md | 31 +
...ginatedUserKerberosSourceConnectionList.md | 31 +
docs/PaginatedUserLDAPSourceConnectionList.md | 31 +
docs/PaginatedUserList.md | 31 +
docs/PaginatedUserLoginStageList.md | 31 +
docs/PaginatedUserLogoutStageList.md | 31 +
.../PaginatedUserOAuthSourceConnectionList.md | 31 +
docs/PaginatedUserPlexSourceConnectionList.md | 31 +
docs/PaginatedUserSAMLSourceConnectionList.md | 31 +
docs/PaginatedUserSourceConnectionList.md | 31 +
...ginatedUserTelegramSourceConnectionList.md | 31 +
docs/PaginatedUserWriteStageList.md | 31 +
docs/PaginatedWSFederationProviderList.md | 31 +
docs/PaginatedWebAuthnDeviceList.md | 31 +
docs/PaginatedWebAuthnDeviceTypeList.md | 31 +
docs/Pagination.md | 35 +
docs/PartialGroup.md | 34 +
docs/PartialUser.md | 37 +
docs/PasswordChallenge.md | 36 +
docs/PasswordChallengeResponseRequest.md | 31 +
docs/PasswordExpiryPolicy.md | 39 +
docs/PasswordExpiryPolicyRequest.md | 33 +
docs/PasswordPolicy.md | 50 +
docs/PasswordPolicyRequest.md | 44 +
docs/PasswordStage.md | 40 +
docs/PasswordStageRequest.md | 34 +
docs/PatchedAccountLockdownStageRequest.md | 35 +
docs/PatchedAgentConnectorRequest.md | 42 +
...hedAppleIndependentSecureEnclaveRequest.md | 33 +
docs/PatchedApplicationEntitlementRequest.md | 32 +
docs/PatchedApplicationRequest.md | 41 +
docs/PatchedAuthenticatorDuoStageRequest.md | 37 +
docs/PatchedAuthenticatorEmailStageRequest.md | 44 +
...edAuthenticatorEndpointGDTCStageRequest.md | 33 +
docs/PatchedAuthenticatorSMSStageRequest.md | 40 +
.../PatchedAuthenticatorStaticStageRequest.md | 34 +
docs/PatchedAuthenticatorTOTPStageRequest.md | 33 +
...atchedAuthenticatorValidateStageRequest.md | 41 +
...atchedAuthenticatorWebAuthnStageRequest.md | 39 +
docs/PatchedBlueprintInstanceRequest.md | 34 +
docs/PatchedBrandRequest.md | 47 +
docs/PatchedCaptchaStageRequest.md | 38 +
docs/PatchedCertificateKeyPairRequest.md | 32 +
docs/PatchedConnectionTokenRequest.md | 32 +
docs/PatchedConsentStageRequest.md | 32 +
docs/PatchedDenyStageRequest.md | 31 +
docs/PatchedDeviceAccessGroupRequest.md | 30 +
docs/PatchedDeviceUserBindingRequest.md | 39 +
docs/PatchedDockerServiceConnectionRequest.md | 34 +
docs/PatchedDomainRequest.md | 32 +
docs/PatchedDummyPolicyRequest.md | 34 +
docs/PatchedDummyStageRequest.md | 31 +
docs/PatchedDuoDeviceRequest.md | 30 +
docs/PatchedEmailDeviceRequest.md | 30 +
docs/PatchedEmailStageRequest.md | 45 +
docs/PatchedEndpointDeviceRequest.md | 35 +
docs/PatchedEndpointRequest.md | 37 +
docs/PatchedEndpointStageRequest.md | 32 +
docs/PatchedEnrollmentTokenRequest.md | 33 +
docs/PatchedEventMatcherPolicyRequest.md | 36 +
docs/PatchedEventRequest.md | 36 +
docs/PatchedExpressionPolicyRequest.md | 32 +
docs/PatchedFleetConnectorRequest.md | 37 +
docs/PatchedFlowRequest.md | 39 +
docs/PatchedFlowStageBindingRequest.md | 36 +
docs/PatchedGeoIPPolicyRequest.md | 39 +
docs/PatchedGoogleChromeConnectorRequest.md | 33 +
docs/PatchedGoogleEndpointDeviceRequest.md | 31 +
...edGoogleWorkspaceProviderMappingRequest.md | 32 +
docs/PatchedGoogleWorkspaceProviderRequest.md | 43 +
...hedGroupKerberosSourceConnectionRequest.md | 32 +
...PatchedGroupLDAPSourceConnectionRequest.md | 32 +
...atchedGroupOAuthSourceConnectionRequest.md | 32 +
...PatchedGroupPlexSourceConnectionRequest.md | 32 +
docs/PatchedGroupRequest.md | 35 +
...PatchedGroupSAMLSourceConnectionRequest.md | 32 +
docs/PatchedGroupSourceConnectionRequest.md | 32 +
...hedGroupTelegramSourceConnectionRequest.md | 32 +
docs/PatchedIdentificationStageRequest.md | 43 +
docs/PatchedInitialPermissionsRequest.md | 32 +
docs/PatchedInvitationRequest.md | 34 +
docs/PatchedInvitationStageRequest.md | 31 +
...hedKerberosSourcePropertyMappingRequest.md | 32 +
docs/PatchedKerberosSourceRequest.md | 56 +
...tchedKubernetesServiceConnectionRequest.md | 33 +
docs/PatchedLDAPProviderRequest.md | 42 +
...PatchedLDAPSourcePropertyMappingRequest.md | 32 +
docs/PatchedLDAPSourceRequest.md | 64 +
docs/PatchedLicenseRequest.md | 30 +
docs/PatchedLifecycleRuleRequest.md | 39 +
...hedMicrosoftEntraProviderMappingRequest.md | 32 +
docs/PatchedMicrosoftEntraProviderRequest.md | 42 +
docs/PatchedMutualTLSStageRequest.md | 34 +
docs/PatchedNotificationRequest.md | 33 +
docs/PatchedNotificationRuleRequest.md | 34 +
docs/PatchedNotificationTransportRequest.md | 38 +
...atchedNotificationWebhookMappingRequest.md | 31 +
docs/PatchedOAuth2ProviderRequest.md | 52 +
...atchedOAuthSourcePropertyMappingRequest.md | 32 +
docs/PatchedOAuthSourceRequest.md | 55 +
docs/PatchedOutpostRequest.md | 35 +
docs/PatchedPasswordExpiryPolicyRequest.md | 33 +
docs/PatchedPasswordPolicyRequest.md | 44 +
docs/PatchedPasswordStageRequest.md | 34 +
docs/PatchedPermissionAssignRequest.md | 32 +
...PatchedPlexSourcePropertyMappingRequest.md | 32 +
docs/PatchedPlexSourceRequest.md | 46 +
docs/PatchedPolicyBindingRequest.md | 38 +
docs/PatchedPromptRequest.md | 40 +
docs/PatchedPromptStageRequest.md | 32 +
docs/PatchedProxyProviderRequest.md | 49 +
docs/PatchedRACPropertyMappingRequest.md | 33 +
docs/PatchedRACProviderRequest.md | 36 +
...hedRadiusProviderPropertyMappingRequest.md | 32 +
docs/PatchedRadiusProviderRequest.md | 38 +
docs/PatchedRedirectStageRequest.md | 34 +
docs/PatchedReputationPolicyRequest.md | 34 +
docs/PatchedRoleRequest.md | 30 +
docs/PatchedSAMLPropertyMappingRequest.md | 34 +
docs/PatchedSAMLProviderRequest.md | 57 +
...PatchedSAMLSourcePropertyMappingRequest.md | 32 +
docs/PatchedSAMLSourceRequest.md | 58 +
docs/PatchedSCIMMappingRequest.md | 32 +
docs/PatchedSCIMProviderRequest.md | 45 +
docs/PatchedSCIMSourceGroupRequest.md | 34 +
...PatchedSCIMSourcePropertyMappingRequest.md | 32 +
docs/PatchedSCIMSourceRequest.md | 35 +
docs/PatchedSCIMSourceUserRequest.md | 34 +
docs/PatchedSMSDeviceRequest.md | 30 +
docs/PatchedSSFProviderRequest.md | 34 +
docs/PatchedScheduleRequest.md | 31 +
docs/PatchedScopeMappingRequest.md | 34 +
docs/PatchedSettingsRequest.md | 45 +
docs/PatchedSettingsRequestFlags.md | 32 +
docs/PatchedSourceStageRequest.md | 32 +
docs/PatchedStaticDeviceRequest.md | 30 +
docs/PatchedTOTPDeviceRequest.md | 30 +
...hedTelegramSourcePropertyMappingRequest.md | 32 +
docs/PatchedTelegramSourceRequest.md | 45 +
docs/PatchedTenantRequest.md | 32 +
docs/PatchedTokenRequest.md | 36 +
docs/PatchedUniquePasswordPolicyRequest.md | 33 +
docs/PatchedUserDeleteStageRequest.md | 30 +
...chedUserKerberosSourceConnectionRequest.md | 32 +
.../PatchedUserLDAPSourceConnectionRequest.md | 32 +
docs/PatchedUserLoginStageRequest.md | 36 +
docs/PatchedUserLogoutStageRequest.md | 30 +
...PatchedUserOAuthSourceConnectionRequest.md | 34 +
.../PatchedUserPlexSourceConnectionRequest.md | 33 +
docs/PatchedUserRequest.md | 39 +
.../PatchedUserSAMLSourceConnectionRequest.md | 32 +
docs/PatchedUserSourceConnectionRequest.md | 32 +
...chedUserTelegramSourceConnectionRequest.md | 32 +
docs/PatchedUserWriteStageRequest.md | 35 +
docs/PatchedWSFederationProviderRequest.md | 48 +
docs/PatchedWebAuthnDeviceRequest.md | 30 +
docs/Permission.md | 36 +
docs/PermissionAssignRequest.md | 32 +
docs/PermissionAssignResult.md | 30 +
docs/PlexAuthenticationChallenge.md | 34 +
...xAuthenticationChallengeResponseRequest.md | 30 +
docs/PlexSource.md | 54 +
docs/PlexSourcePropertyMapping.md | 37 +
docs/PlexSourcePropertyMappingRequest.md | 32 +
docs/PlexSourceRequest.md | 46 +
docs/PlexTokenRedeemRequest.md | 30 +
docs/PoliciesApi.md | 6172 ++
docs/Policy.md | 37 +
docs/PolicyBinding.md | 42 +
docs/PolicyBindingRequest.md | 38 +
docs/PolicyEngineMode.md | 12 +
docs/PolicyTestRequest.md | 31 +
docs/PolicyTestResult.md | 32 +
docs/Process.md | 31 +
docs/ProcessRequest.md | 31 +
docs/Prompt.md | 42 +
docs/PromptChallenge.md | 33 +
docs/PromptChallengeResponseRequest.md | 30 +
docs/PromptChoice.md | 31 +
docs/PromptRequest.md | 40 +
docs/PromptStage.md | 38 +
docs/PromptStageRequest.md | 32 +
docs/PromptTypeEnum.md | 50 +
docs/PropertyMapping.md | 37 +
docs/PropertyMappingPreview.md | 30 +
docs/PropertyMappingTestRequest.md | 32 +
docs/PropertyMappingTestResult.md | 31 +
docs/PropertymappingsApi.md | 8920 +++
docs/ProtocolEnum.md | 14 +
docs/Provider.md | 43 +
docs/ProviderEnum.md | 12 +
docs/ProviderModelEnum.md | 30 +
docs/ProviderTypeEnum.md | 42 +
docs/ProvidersApi.md | 10201 +++
docs/ProxyMode.md | 14 +
docs/ProxyOutpostConfig.md | 50 +
docs/ProxyProvider.md | 61 +
docs/ProxyProviderRequest.md | 49 +
docs/RACPropertyMapping.md | 38 +
docs/RACPropertyMappingRequest.md | 33 +
docs/RACProvider.md | 46 +
docs/RACProviderRequest.md | 36 +
docs/RacApi.md | 1053 +
docs/RadiusCheckAccess.md | 31 +
docs/RadiusOutpostConfig.md | 37 +
docs/RadiusProvider.md | 48 +
docs/RadiusProviderPropertyMapping.md | 37 +
docs/RadiusProviderPropertyMappingRequest.md | 32 +
docs/RadiusProviderRequest.md | 38 +
docs/RbacApi.md | 1797 +
docs/RedirectChallenge.md | 33 +
docs/RedirectChallengeResponseRequest.md | 31 +
docs/RedirectStage.md | 40 +
docs/RedirectStageModeEnum.md | 12 +
docs/RedirectStageRequest.md | 34 +
docs/RedirectURI.md | 32 +
docs/RedirectURIRequest.md | 32 +
docs/RedirectURITypeEnum.md | 12 +
docs/RelatedGroup.md | 34 +
docs/RelatedRule.md | 34 +
docs/ReportsApi.md | 239 +
docs/Reputation.md | 36 +
docs/ReputationPolicy.md | 40 +
docs/ReputationPolicyRequest.md | 34 +
docs/Review.md | 34 +
docs/ReviewRequest.md | 31 +
docs/ReviewerGroup.md | 30 +
docs/ReviewerUser.md | 32 +
docs/Role.md | 31 +
docs/RoleAssignedObjectPermission.md | 33 +
docs/RoleModelPermission.md | 34 +
docs/RoleObjectPermission.md | 35 +
docs/RoleRequest.md | 30 +
docs/RootApi.md | 82 +
docs/SAMLBindingsEnum.md | 12 +
docs/SAMLLogoutMethods.md | 14 +
docs/SAMLMetadata.md | 31 +
docs/SAMLNameIDPolicyEnum.md | 20 +
docs/SAMLPropertyMapping.md | 39 +
docs/SAMLPropertyMappingRequest.md | 34 +
docs/SAMLProvider.md | 75 +
docs/SAMLProviderRequest.md | 57 +
docs/SAMLSource.md | 66 +
docs/SAMLSourcePropertyMapping.md | 37 +
docs/SAMLSourcePropertyMappingRequest.md | 32 +
docs/SAMLSourceRequest.md | 58 +
docs/SCIMAuthenticationModeEnum.md | 12 +
docs/SCIMMapping.md | 37 +
docs/SCIMMappingRequest.md | 32 +
docs/SCIMProvider.md | 52 +
docs/SCIMProviderGroup.md | 35 +
docs/SCIMProviderGroupRequest.md | 32 +
docs/SCIMProviderRequest.md | 45 +
docs/SCIMProviderUser.md | 35 +
docs/SCIMProviderUserRequest.md | 32 +
docs/SCIMSource.md | 43 +
docs/SCIMSourceGroup.md | 35 +
docs/SCIMSourceGroupRequest.md | 34 +
docs/SCIMSourcePropertyMapping.md | 37 +
docs/SCIMSourcePropertyMappingRequest.md | 32 +
docs/SCIMSourceRequest.md | 35 +
docs/SCIMSourceUser.md | 35 +
docs/SCIMSourceUserRequest.md | 34 +
docs/SMSDevice.md | 33 +
docs/SMSDeviceRequest.md | 30 +
docs/SSFProvider.md | 42 +
docs/SSFProviderRequest.md | 34 +
docs/SSFStream.md | 39 +
docs/SSFStreamStatusEnum.md | 16 +
docs/Schedule.md | 40 +
docs/ScheduleRequest.md | 31 +
docs/SchemaApi.md | 92 +
docs/ScopeMapping.md | 39 +
docs/ScopeMappingRequest.md | 34 +
docs/SelectableStage.md | 33 +
docs/ServiceConnection.md | 36 +
docs/ServiceConnectionState.md | 31 +
docs/SessionEndChallenge.md | 38 +
docs/SessionUser.md | 31 +
docs/Settings.md | 45 +
docs/SettingsRequest.md | 45 +
docs/SeverityEnum.md | 14 +
docs/ShellChallenge.md | 33 +
docs/SignatureAlgorithmEnum.md | 26 +
docs/Software.md | 32 +
docs/SoftwareRequest.md | 32 +
docs/Source.md | 49 +
docs/SourceStage.md | 38 +
docs/SourceStageRequest.md | 32 +
docs/SourceType.md | 38 +
docs/SourcesApi.md | 14024 ++++
docs/SsfApi.md | 252 +
docs/Stage.md | 36 +
docs/StageModeEnum.md | 12 +
docs/StagePrompt.md | 38 +
docs/StagesApi.md | 16974 +++++
docs/StaticDevice.md | 33 +
docs/StaticDeviceRequest.md | 30 +
docs/StaticDeviceToken.md | 30 +
docs/SubModeEnum.md | 20 +
docs/SyncObjectModelEnum.md | 12 +
docs/SyncObjectRequest.md | 32 +
docs/SyncObjectResult.md | 30 +
docs/SyncOutgoingTriggerModeEnum.md | 14 +
docs/SyncStatus.md | 32 +
docs/SystemInfo.md | 37 +
docs/SystemInfoRuntime.md | 37 +
docs/TOTPDevice.md | 32 +
docs/TOTPDeviceRequest.md | 30 +
docs/Task.md | 43 +
docs/TaskAggregatedStatusEnum.md | 28 +
docs/TaskStatusEnum.md | 22 +
docs/TasksApi.md | 812 +
docs/TelegramAuthRequest.md | 35 +
docs/TelegramChallengeResponseRequest.md | 37 +
docs/TelegramLoginChallenge.md | 34 +
docs/TelegramSource.md | 52 +
docs/TelegramSourcePropertyMapping.md | 37 +
docs/TelegramSourcePropertyMappingRequest.md | 32 +
docs/TelegramSourceRequest.md | 45 +
docs/Tenant.md | 33 +
docs/TenantAdminGroupRequestRequest.md | 30 +
docs/TenantRecoveryKeyRequestRequest.md | 31 +
docs/TenantRecoveryKeyResponse.md | 31 +
docs/TenantRequest.md | 32 +
docs/TenantsApi.md | 985 +
docs/ThemedUrls.md | 31 +
docs/Token.md | 38 +
docs/TokenModel.md | 37 +
docs/TokenRequest.md | 36 +
docs/TokenSetKeyRequest.md | 30 +
docs/TokenView.md | 30 +
docs/TransactionApplicationRequest.md | 33 +
docs/TransactionApplicationResponse.md | 31 +
docs/TransactionPolicyBindingRequest.md | 37 +
docs/TransportModeEnum.md | 16 +
docs/TypeCreate.md | 36 +
docs/UiThemeEnum.md | 14 +
docs/UniquePasswordPolicy.md | 39 +
docs/UniquePasswordPolicyRequest.md | 33 +
docs/UsageEnum.md | 10 +
docs/UsedBy.md | 34 +
docs/UsedByActionEnum.md | 18 +
docs/User.md | 49 +
docs/UserAccountLockdownRequest.md | 30 +
docs/UserAccountRequest.md | 30 +
docs/UserAccountSerializerForRoleRequest.md | 30 +
docs/UserAttributeEnum.md | 12 +
docs/UserConsent.md | 35 +
docs/UserCreationModeEnum.md | 14 +
docs/UserDeleteStage.md | 36 +
docs/UserDeleteStageRequest.md | 30 +
docs/UserFieldsEnum.md | 14 +
docs/UserKerberosSourceConnection.md | 36 +
docs/UserKerberosSourceConnectionRequest.md | 32 +
docs/UserLDAPSourceConnection.md | 37 +
docs/UserLDAPSourceConnectionRequest.md | 32 +
docs/UserLoginChallenge.md | 34 +
docs/UserLoginChallengeResponseRequest.md | 31 +
docs/UserLoginStage.md | 42 +
docs/UserLoginStageRequest.md | 36 +
docs/UserLogoutStage.md | 36 +
docs/UserLogoutStageRequest.md | 30 +
docs/UserMatchingModeEnum.md | 18 +
docs/UserOAuthSourceConnection.md | 37 +
docs/UserOAuthSourceConnectionRequest.md | 34 +
docs/UserPasswordHashSetRequest.md | 30 +
docs/UserPasswordSetRequest.md | 30 +
docs/UserPath.md | 29 +
docs/UserPlexSourceConnection.md | 36 +
docs/UserPlexSourceConnectionRequest.md | 33 +
docs/UserRecoveryEmailRequest.md | 31 +
docs/UserRecoveryLinkRequest.md | 30 +
docs/UserRequest.md | 39 +
docs/UserSAMLSourceConnection.md | 36 +
docs/UserSAMLSourceConnectionRequest.md | 32 +
docs/UserSelf.md | 42 +
docs/UserSelfGroups.md | 30 +
docs/UserSelfRoles.md | 30 +
docs/UserServiceAccountRequest.md | 33 +
docs/UserServiceAccountResponse.md | 33 +
docs/UserSetting.md | 34 +
docs/UserSourceConnection.md | 36 +
docs/UserSourceConnectionRequest.md | 32 +
docs/UserTelegramSourceConnection.md | 36 +
docs/UserTelegramSourceConnectionRequest.md | 32 +
docs/UserTypeEnum.md | 16 +
docs/UserVerificationEnum.md | 14 +
docs/UserWriteStage.md | 41 +
docs/UserWriteStageRequest.md | 35 +
docs/ValidationError.md | 31 +
docs/VendorEnum.md | 16 +
docs/Version.md | 35 +
docs/VersionHistory.md | 33 +
docs/WSFederationProvider.md | 59 +
docs/WSFederationProviderRequest.md | 48 +
docs/WebAuthnDevice.md | 35 +
docs/WebAuthnDeviceRequest.md | 30 +
docs/WebAuthnDeviceType.md | 31 +
docs/WebAuthnHintEnum.md | 14 +
docs/Worker.md | 31 +
pyproject.toml | 95 +
requirements.txt | 4 +
schema.yml | 59083 +++++++++++++++
setup.cfg | 2 +
setup.py | 49 +
test-requirements.txt | 6 +
test/__init__.py | 0
test/test_access_denied_challenge.py | 70 +
test/test_account_lockdown_stage.py | 98 +
test/test_account_lockdown_stage_request.py | 58 +
test/test_admin_api.py | 116 +
test/test_agent_authentication_response.py | 53 +
test/test_agent_config.py | 103 +
test/test_agent_connector.py | 76 +
test/test_agent_connector_request.py | 68 +
..._agent_psso_device_registration_request.py | 59 +
...agent_psso_device_registration_response.py | 63 +
...st_agent_psso_user_registration_request.py | 57 +
test/test_agent_token_response.py | 54 +
test/test_alg_enum.py | 34 +
test/test_app.py | 55 +
test/test_app_enum.py | 34 +
test/test_apple_challenge_response_request.py | 52 +
test/test_apple_independent_secure_enclave.py | 60 +
...pple_independent_secure_enclave_request.py | 60 +
test/test_apple_login_challenge.py | 73 +
test/test_application.py | 151 +
test/test_application_entitlement.py | 60 +
test/test_application_entitlement_request.py | 58 +
test/test_application_request.py | 67 +
test/test_auth_type_enum.py | 34 +
test/test_authenticated_session.py | 118 +
test/test_authenticated_session_asn.py | 57 +
test/test_authenticated_session_geo_ip.py | 61 +
test/test_authenticated_session_user_agent.py | 83 +
...authenticated_session_user_agent_device.py | 57 +
...est_authenticated_session_user_agent_os.py | 61 +
...enticated_session_user_agent_user_agent.py | 59 +
test/test_authentication_enum.py | 34 +
test/test_authenticator_attachment_enum.py | 34 +
test/test_authenticator_duo_challenge.py | 75 +
...nticator_duo_challenge_response_request.py | 52 +
test/test_authenticator_duo_stage.py | 100 +
...icator_duo_stage_device_import_response.py | 55 +
..._duo_stage_manual_device_import_request.py | 55 +
test/test_authenticator_duo_stage_request.py | 63 +
test/test_authenticator_email_challenge.py | 71 +
...icator_email_challenge_response_request.py | 54 +
test/test_authenticator_email_stage.py | 107 +
.../test_authenticator_email_stage_request.py | 67 +
.../test_authenticator_endpoint_gdtc_stage.py | 101 +
...thenticator_endpoint_gdtc_stage_request.py | 61 +
test/test_authenticator_sms_challenge.py | 70 +
...nticator_sms_challenge_response_request.py | 54 +
test/test_authenticator_sms_stage.py | 107 +
test/test_authenticator_sms_stage_request.py | 67 +
test/test_authenticator_static_challenge.py | 75 +
...cator_static_challenge_response_request.py | 52 +
test/test_authenticator_static_stage.py | 97 +
...test_authenticator_static_stage_request.py | 57 +
test/test_authenticator_totp_challenge.py | 71 +
...ticator_totp_challenge_response_request.py | 54 +
test/test_authenticator_totp_stage.py | 97 +
test/test_authenticator_totp_stage_request.py | 57 +
test/test_authenticator_validate_stage.py | 122 +
...st_authenticator_validate_stage_request.py | 72 +
...test_authenticator_validation_challenge.py | 101 +
...r_validation_challenge_response_request.py | 65 +
.../test_authenticator_web_authn_challenge.py | 75 +
...or_web_authn_challenge_response_request.py | 58 +
test/test_authenticator_web_authn_stage.py | 116 +
...t_authenticator_web_authn_stage_request.py | 66 +
test/test_authenticators_api.py | 530 +
...est_authorization_code_auth_method_enum.py | 34 +
..._auto_submit_challenge_response_request.py | 52 +
test/test_autosubmit_challenge.py | 74 +
test/test_backends_enum.py | 34 +
test/test_binding_type_enum.py | 34 +
test/test_blueprint_file.py | 67 +
test/test_blueprint_import_result.py | 73 +
test/test_blueprint_instance.py | 79 +
test/test_blueprint_instance_request.py | 59 +
test/test_blueprint_instance_status_enum.py | 34 +
test/test_brand.py | 76 +
test/test_brand_request.py | 74 +
test/test_bulk_delete_session_response.py | 53 +
test/test_cache.py | 53 +
test/test_capabilities_enum.py | 34 +
test/test_captcha_challenge.py | 75 +
...test_captcha_challenge_response_request.py | 54 +
test/test_captcha_stage.py | 101 +
test/test_captcha_stage_request.py | 63 +
test/test_cert_attribute_enum.py | 34 +
test/test_certificate_data.py | 53 +
test/test_certificate_generation_request.py | 57 +
test/test_certificate_key_pair.py | 73 +
...test_certificate_key_pair_key_type_enum.py | 34 +
test/test_certificate_key_pair_request.py | 56 +
test/test_challenge_types.py | 300 +
test/test_client_type_enum.py | 34 +
test/test_compatibility_mode_enum.py | 34 +
test/test_config.py | 75 +
test/test_connection_token.py | 158 +
test/test_connection_token_request.py | 56 +
test/test_connector.py | 63 +
test/test_consent_challenge.py | 92 +
...test_consent_challenge_response_request.py | 54 +
test/test_consent_mode_enum.py | 34 +
test/test_consent_permission.py | 55 +
test/test_consent_stage.py | 95 +
test/test_consent_stage_request.py | 55 +
test/test_content_type.py | 59 +
test/test_content_type_enum.py | 34 +
test/test_contextual_flow_info.py | 60 +
test/test_contextual_flow_info_layout_enum.py | 34 +
test/test_core_api.py | 446 +
test/test_country_code_enum.py | 34 +
test/test_crypto_api.py | 92 +
test/test_current_brand.py | 104 +
test/test_current_brand_flags.py | 59 +
test/test_data_export.py | 97 +
test/test_delivery_method_enum.py | 34 +
test/test_denied_action_enum.py | 34 +
test/test_deny_stage.py | 94 +
test/test_deny_stage_request.py | 54 +
test/test_detailed_country.py | 55 +
test/test_device.py | 75 +
test/test_device_access_group.py | 58 +
test/test_device_access_group_request.py | 56 +
test/test_device_challenge.py | 63 +
test/test_device_challenge_request.py | 63 +
test/test_device_classes_enum.py | 34 +
test/test_device_connection.py | 163 +
test/test_device_fact_snapshot.py | 141 +
test/test_device_facts.py | 115 +
test/test_device_facts_os_family.py | 34 +
test/test_device_facts_request.py | 115 +
test/test_device_group.py | 54 +
test/test_device_group_request.py | 54 +
test/test_device_summary.py | 57 +
test/test_device_user.py | 56 +
test/test_device_user_binding.py | 139 +
test/test_device_user_binding_request.py | 63 +
test/test_device_user_request.py | 56 +
test/test_digest_algorithm_enum.py | 34 +
test/test_digits_enum.py | 34 +
test/test_disk.py | 59 +
test/test_disk_request.py | 59 +
test/test_docker_service_connection.py | 68 +
.../test_docker_service_connection_request.py | 58 +
test/test_domain.py | 58 +
test/test_domain_request.py | 56 +
test/test_dummy_challenge.py | 67 +
test/test_dummy_challenge_response_request.py | 52 +
test/test_dummy_policy.py | 69 +
test/test_dummy_policy_request.py | 57 +
test/test_dummy_stage.py | 94 +
test/test_dummy_stage_request.py | 54 +
test/test_duo_device.py | 77 +
test/test_duo_device_enrollment_status.py | 53 +
test/test_duo_device_request.py | 53 +
test/test_duo_response_enum.py | 34 +
test/test_email_challenge.py | 65 +
test/test_email_challenge_response_request.py | 52 +
test/test_email_device.py | 79 +
test/test_email_device_request.py | 53 +
test/test_email_stage.py | 107 +
test/test_email_stage_request.py | 68 +
test/test_endpoint.py | 120 +
test/test_endpoint_agent_challenge.py | 69 +
...dpoint_agent_challenge_response_request.py | 53 +
test/test_endpoint_auth_mode_enum.py | 34 +
test/test_endpoint_device.py | 160 +
test/test_endpoint_device_details.py | 186 +
test/test_endpoint_device_request.py | 65 +
test/test_endpoint_request.py | 68 +
test/test_endpoint_stage.py | 112 +
test/test_endpoint_stage_request.py | 56 +
test/test_endpoints_api.py | 452 +
test/test_enroll_request.py | 55 +
test/test_enrollment_token.py | 72 +
test/test_enrollment_token_request.py | 58 +
test/test_enterprise_api.py | 92 +
test/test_error_detail.py | 55 +
test/test_error_reporting_config.py | 61 +
test/test_event.py | 70 +
test/test_event_actions.py | 34 +
test/test_event_matcher_policy.py | 71 +
test/test_event_matcher_policy_request.py | 59 +
test/test_event_request.py | 66 +
test/test_event_stats.py | 59 +
test/test_event_top_per_user.py | 61 +
test/test_event_volume.py | 57 +
test/test_events_api.py | 230 +
test/test_events_requested_enum.py | 34 +
test/test_expiring_base_grant_model.py | 234 +
test/test_expression_policy.py | 68 +
test/test_expression_policy_request.py | 56 +
test/test_extra_role_object_permission.py | 69 +
test/test_file_list.py | 60 +
test/test_fleet_connector.py | 68 +
test/test_fleet_connector_request.py | 62 +
test/test_flow.py | 93 +
test/test_flow_challenge_response_request.py | 93 +
test/test_flow_designation_enum.py | 34 +
test/test_flow_diagram.py | 53 +
test/test_flow_error_challenge.py | 69 +
test/test_flow_inspection.py | 78 +
test/test_flow_inspector_plan.py | 103 +
test/test_flow_layout_enum.py | 34 +
test/test_flow_request.py | 65 +
test/test_flow_set.py | 71 +
test/test_flow_stage_binding.py | 109 +
test/test_flow_stage_binding_request.py | 61 +
test/test_flows_api.py | 164 +
test/test_footer_link.py | 55 +
test/test_force_binding_enum.py | 34 +
test/test_format_enum.py | 34 +
test/test_frame_challenge.py | 70 +
test/test_frame_challenge_response_request.py | 52 +
test/test_generic_error.py | 54 +
test/test_geo_ip_policy.py | 91 +
.../test_geo_ip_policy_countries_obj_inner.py | 55 +
test/test_geo_ip_policy_request.py | 69 +
test/test_geoip_binding_enum.py | 34 +
test/test_global_task_status.py | 71 +
test/test_google_chrome_connector.py | 71 +
test/test_google_chrome_connector_request.py | 61 +
test/test_google_endpoint_device.py | 54 +
test/test_google_endpoint_device_request.py | 54 +
test/test_google_workspace_provider.py | 91 +
test/test_google_workspace_provider_group.py | 81 +
...google_workspace_provider_group_request.py | 57 +
.../test_google_workspace_provider_mapping.py | 66 +
...ogle_workspace_provider_mapping_request.py | 56 +
.../test_google_workspace_provider_request.py | 77 +
test/test_google_workspace_provider_user.py | 87 +
..._google_workspace_provider_user_request.py | 57 +
test/test_grant_types_enum.py | 34 +
test/test_group.py | 162 +
test/test_group_kerberos_source_connection.py | 113 +
...roup_kerberos_source_connection_request.py | 57 +
test/test_group_ldap_source_connection.py | 129 +
...st_group_ldap_source_connection_request.py | 57 +
test/test_group_matching_mode_enum.py | 34 +
test/test_group_o_auth_source_connection.py | 113 +
..._group_o_auth_source_connection_request.py | 57 +
test/test_group_plex_source_connection.py | 113 +
...st_group_plex_source_connection_request.py | 57 +
test/test_group_request.py | 66 +
test/test_group_saml_source_connection.py | 113 +
...st_group_saml_source_connection_request.py | 57 +
test/test_group_source_connection.py | 113 +
test/test_group_source_connection_request.py | 57 +
test/test_group_telegram_source_connection.py | 113 +
...roup_telegram_source_connection_request.py | 57 +
test/test_hardware.py | 58 +
test/test_hardware_request.py | 58 +
test/test_identification_challenge.py | 117 +
...entification_challenge_response_request.py | 58 +
test/test_identification_stage.py | 110 +
test/test_identification_stage_request.py | 70 +
test/test_iframe_logout_challenge.py | 74 +
...frame_logout_challenge_response_request.py | 52 +
test/test_impersonation_request.py | 53 +
test/test_initial_permissions.py | 80 +
test/test_initial_permissions_request.py | 58 +
test/test_install_id.py | 53 +
test/test_intent_enum.py | 34 +
test/test_invalid_response_action_enum.py | 34 +
test/test_invitation.py | 129 +
test/test_invitation_request.py | 59 +
test/test_invitation_send_email_request.py | 64 +
test/test_invitation_stage.py | 94 +
test/test_invitation_stage_request.py | 54 +
test/test_issuer_mode_enum.py | 34 +
test/test_kadmin_type_enum.py | 34 +
test/test_kerberos_source.py | 108 +
test/test_kerberos_source_property_mapping.py | 66 +
...erberos_source_property_mapping_request.py | 56 +
test/test_kerberos_source_request.py | 85 +
test/test_key_type_enum.py | 34 +
test/test_kubernetes_service_connection.py | 68 +
...t_kubernetes_service_connection_request.py | 58 +
test/test_lang_enum.py | 34 +
test/test_last_task_status_enum.py | 34 +
test/test_ldap_check_access.py | 82 +
test/test_ldap_debug.py | 81 +
test/test_ldap_outpost_config.py | 69 +
test/test_ldap_provider.py | 93 +
test/test_ldap_provider_request.py | 69 +
test/test_ldap_source.py | 123 +
test/test_ldap_source_property_mapping.py | 66 +
...st_ldap_source_property_mapping_request.py | 56 +
test/test_ldap_source_request.py | 94 +
test/test_ldapapi_access_mode.py | 34 +
test/test_license.py | 63 +
test/test_license_flags_enum.py | 34 +
test/test_license_forecast.py | 59 +
test/test_license_request.py | 53 +
test/test_license_status_enum.py | 34 +
test/test_license_summary.py | 65 +
test/test_license_summary_status_enum.py | 34 +
test/test_lifecycle_api.py | 92 +
test/test_lifecycle_iteration.py | 119 +
test/test_lifecycle_iteration_request.py | 53 +
test/test_lifecycle_iteration_state_enum.py | 34 +
test/test_lifecycle_rule.py | 100 +
test/test_lifecycle_rule_request.py | 72 +
test/test_link.py | 53 +
test/test_log_event.py | 65 +
test/test_log_level_enum.py | 34 +
test/test_login_challenge_types.py | 81 +
test/test_login_source.py | 57 +
test/test_logout_url.py | 58 +
test/test_managed_api.py | 92 +
test/test_matching_mode_enum.py | 34 +
test/test_mdm_config_request.py | 55 +
test/test_mdm_config_response.py | 57 +
test/test_metadata.py | 59 +
test/test_microsoft_entra_provider.py | 86 +
test/test_microsoft_entra_provider_group.py | 81 +
..._microsoft_entra_provider_group_request.py | 57 +
test/test_microsoft_entra_provider_mapping.py | 66 +
...icrosoft_entra_provider_mapping_request.py | 56 +
test/test_microsoft_entra_provider_request.py | 72 +
test/test_microsoft_entra_provider_user.py | 87 +
...t_microsoft_entra_provider_user_request.py | 57 +
test/test_model_enum.py | 34 +
test/test_model_request.py | 194 +
test/test_mutual_tls_stage.py | 102 +
test/test_mutual_tls_stage_request.py | 62 +
test/test_native_logout_challenge.py | 73 +
...ative_logout_challenge_response_request.py | 52 +
test/test_network.py | 77 +
test/test_network_binding_enum.py | 34 +
test/test_network_interface.py | 61 +
test/test_network_interface_request.py | 61 +
test/test_network_request.py | 77 +
test/test_not_configured_action_enum.py | 34 +
test/test_notification.py | 78 +
test/test_notification_request.py | 68 +
test/test_notification_rule.py | 175 +
test/test_notification_rule_request.py | 59 +
test/test_notification_transport.py | 65 +
test/test_notification_transport_request.py | 61 +
test/test_notification_transport_test.py | 57 +
test/test_notification_webhook_mapping.py | 57 +
...st_notification_webhook_mapping_request.py | 55 +
test/test_o_auth2_provider.py | 114 +
...est_o_auth2_provider_logout_method_enum.py | 34 +
test/test_o_auth2_provider_request.py | 96 +
test/test_o_auth2_provider_setup_urls.py | 65 +
test/test_o_auth_device_code_challenge.py | 65 +
..._device_code_challenge_response_request.py | 54 +
...est_o_auth_device_code_finish_challenge.py | 65 +
..._code_finish_challenge_response_request.py | 52 +
test/test_o_auth_source.py | 128 +
test/test_o_auth_source_property_mapping.py | 66 +
..._o_auth_source_property_mapping_request.py | 56 +
test/test_o_auth_source_request.py | 88 +
test/test_oauth2_api.py | 104 +
test/test_open_id_connect_configuration.py | 89 +
test/test_operating_system.py | 56 +
test/test_operating_system_request.py | 56 +
test/test_outgoing_sync_delete_action.py | 34 +
test/test_outpost.py | 129 +
test/test_outpost_default_config.py | 57 +
test/test_outpost_health.py | 75 +
test/test_outpost_request.py | 69 +
test/test_outpost_type_enum.py | 34 +
test/test_outposts_api.py | 236 +
...t_paginated_account_lockdown_stage_list.py | 131 +
test/test_paginated_agent_connector_list.py | 119 +
...d_apple_independent_secure_enclave_list.py | 89 +
..._paginated_application_entitlement_list.py | 91 +
test/test_paginated_application_list.py | 155 +
...st_paginated_authenticated_session_list.py | 147 +
..._paginated_authenticator_duo_stage_list.py | 131 +
...aginated_authenticator_email_stage_list.py | 149 +
..._authenticator_endpoint_gdtc_stage_list.py | 131 +
..._paginated_authenticator_sms_stage_list.py | 141 +
...ginated_authenticator_static_stage_list.py | 129 +
...paginated_authenticator_totp_stage_list.py | 127 +
...nated_authenticator_validate_stage_list.py | 169 +
...ated_authenticator_web_authn_stage_list.py | 157 +
.../test_paginated_blueprint_instance_list.py | 113 +
test/test_paginated_brand_list.py | 125 +
test/test_paginated_captcha_stage_list.py | 135 +
...est_paginated_certificate_key_pair_list.py | 101 +
test/test_paginated_connection_token_list.py | 91 +
test/test_paginated_connector_list.py | 93 +
test/test_paginated_consent_stage_list.py | 125 +
test/test_paginated_data_export_list.py | 97 +
test/test_paginated_deny_stage_list.py | 123 +
...test_paginated_device_access_group_list.py | 89 +
...test_paginated_device_user_binding_list.py | 111 +
...aginated_docker_service_connection_list.py | 99 +
test/test_paginated_domain_list.py | 87 +
test/test_paginated_dummy_policy_list.py | 101 +
test/test_paginated_dummy_stage_list.py | 123 +
test/test_paginated_duo_device_list.py | 85 +
test/test_paginated_email_device_list.py | 87 +
test/test_paginated_email_stage_list.py | 149 +
test/test_paginated_endpoint_device_list.py | 111 +
test/test_paginated_endpoint_list.py | 109 +
test/test_paginated_endpoint_stage_list.py | 127 +
test/test_paginated_enrollment_token_list.py | 93 +
test/test_paginated_event_list.py | 109 +
...est_paginated_event_matcher_policy_list.py | 105 +
...aginated_expiring_base_grant_model_list.py | 263 +
test/test_paginated_expression_policy_list.py | 97 +
...nated_extra_role_object_permission_list.py | 97 +
test/test_paginated_fleet_connector_list.py | 101 +
test/test_paginated_flow_list.py | 123 +
.../test_paginated_flow_stage_binding_list.py | 99 +
test/test_paginated_geo_ip_policy_list.py | 129 +
..._paginated_google_chrome_connector_list.py | 101 +
...t_paginated_google_endpoint_device_list.py | 83 +
...ed_google_workspace_provider_group_list.py | 95 +
...aginated_google_workspace_provider_list.py | 133 +
..._google_workspace_provider_mapping_list.py | 95 +
...ted_google_workspace_provider_user_list.py | 95 +
...d_group_kerberos_source_connection_list.py | 93 +
...nated_group_ldap_source_connection_list.py | 95 +
test/test_paginated_group_list.py | 191 +
...ted_group_o_auth_source_connection_list.py | 93 +
...nated_group_plex_source_connection_list.py | 93 +
...nated_group_saml_source_connection_list.py | 93 +
..._paginated_group_source_connection_list.py | 93 +
...d_group_telegram_source_connection_list.py | 93 +
...est_paginated_identification_stage_list.py | 155 +
...test_paginated_initial_permissions_list.py | 111 +
test/test_paginated_invitation_list.py | 99 +
test/test_paginated_invitation_stage_list.py | 123 +
test/test_paginated_kerberos_source_list.py | 157 +
...d_kerberos_source_property_mapping_list.py | 95 +
...ated_kubernetes_service_connection_list.py | 101 +
...test_paginated_ldap_outpost_config_list.py | 105 +
test/test_paginated_ldap_provider_list.py | 133 +
test/test_paginated_ldap_source_list.py | 181 +
...nated_ldap_source_property_mapping_list.py | 95 +
test/test_paginated_license_list.py | 91 +
...test_paginated_lifecycle_iteration_list.py | 117 +
test/test_paginated_lifecycle_rule_list.py | 139 +
...ted_microsoft_entra_provider_group_list.py | 95 +
...paginated_microsoft_entra_provider_list.py | 127 +
...d_microsoft_entra_provider_mapping_list.py | 95 +
...ated_microsoft_entra_provider_user_list.py | 95 +
test/test_paginated_mutual_tls_stage_list.py | 133 +
test/test_paginated_notification_list.py | 125 +
test/test_paginated_notification_rule_list.py | 97 +
...t_paginated_notification_transport_list.py | 101 +
...nated_notification_webhook_mapping_list.py | 85 +
test/test_paginated_o_auth2_provider_list.py | 169 +
test/test_paginated_o_auth_source_list.py | 161 +
...ted_o_auth_source_property_mapping_list.py | 95 +
test/test_paginated_outpost_list.py | 145 +
...t_paginated_password_expiry_policy_list.py | 99 +
test/test_paginated_password_policy_list.py | 121 +
test/test_paginated_password_stage_list.py | 133 +
test/test_paginated_permission_list.py | 93 +
test/test_paginated_plex_source_list.py | 141 +
...nated_plex_source_property_mapping_list.py | 95 +
test/test_paginated_policy_binding_list.py | 105 +
test/test_paginated_policy_list.py | 95 +
test/test_paginated_prompt_list.py | 163 +
test/test_paginated_prompt_stage_list.py | 133 +
test/test_paginated_property_mapping_list.py | 95 +
test/test_paginated_provider_list.py | 111 +
...est_paginated_proxy_outpost_config_list.py | 125 +
test/test_paginated_proxy_provider_list.py | 169 +
...est_paginated_rac_property_mapping_list.py | 101 +
test/test_paginated_rac_provider_list.py | 125 +
...st_paginated_radius_outpost_config_list.py | 95 +
test/test_paginated_radius_provider_list.py | 125 +
...d_radius_provider_property_mapping_list.py | 95 +
test/test_paginated_redirect_stage_list.py | 129 +
test/test_paginated_reputation_list.py | 101 +
test/test_paginated_reputation_policy_list.py | 101 +
...ed_role_assigned_object_permission_list.py | 117 +
test/test_paginated_role_list.py | 83 +
...st_paginated_saml_property_mapping_list.py | 99 +
test/test_paginated_saml_provider_list.py | 175 +
test/test_paginated_saml_source_list.py | 161 +
...nated_saml_source_property_mapping_list.py | 95 +
test/test_paginated_schedule_list.py | 103 +
test/test_paginated_scim_mapping_list.py | 95 +
...test_paginated_scim_provider_group_list.py | 95 +
test/test_paginated_scim_provider_list.py | 141 +
.../test_paginated_scim_provider_user_list.py | 95 +
test/test_paginated_scim_source_group_list.py | 95 +
test/test_paginated_scim_source_list.py | 115 +
...nated_scim_source_property_mapping_list.py | 95 +
test/test_paginated_scim_source_user_list.py | 95 +
test/test_paginated_scope_mapping_list.py | 99 +
.../test_paginated_service_connection_list.py | 93 +
test/test_paginated_sms_device_list.py | 87 +
test/test_paginated_source_list.py | 127 +
test/test_paginated_source_stage_list.py | 125 +
test/test_paginated_ssf_provider_list.py | 145 +
test/test_paginated_ssf_stream_list.py | 107 +
test/test_paginated_stage_list.py | 121 +
test/test_paginated_static_device_list.py | 93 +
test/test_paginated_task_list.py | 145 +
test/test_paginated_telegram_source_list.py | 133 +
...d_telegram_source_property_mapping_list.py | 95 +
test/test_paginated_tenant_list.py | 87 +
test/test_paginated_token_list.py | 97 +
test/test_paginated_token_model_list.py | 267 +
test/test_paginated_totp_device_list.py | 85 +
...t_paginated_unique_password_policy_list.py | 99 +
test/test_paginated_user_consent_list.py | 245 +
test/test_paginated_user_delete_stage_list.py | 121 +
...ed_user_kerberos_source_connection_list.py | 93 +
...inated_user_ldap_source_connection_list.py | 95 +
test/test_paginated_user_list.py | 157 +
test/test_paginated_user_login_stage_list.py | 133 +
test/test_paginated_user_logout_stage_list.py | 121 +
...ated_user_o_auth_source_connection_list.py | 95 +
...inated_user_plex_source_connection_list.py | 93 +
...inated_user_saml_source_connection_list.py | 93 +
...t_paginated_user_source_connection_list.py | 93 +
...ed_user_telegram_source_connection_list.py | 93 +
test/test_paginated_user_write_stage_list.py | 131 +
test/test_paginated_web_authn_device_list.py | 91 +
...st_paginated_web_authn_device_type_list.py | 83 +
...t_paginated_ws_federation_provider_list.py | 143 +
test/test_pagination.py | 65 +
test/test_partial_group.py | 61 +
test/test_partial_user.py | 65 +
test/test_password_challenge.py | 71 +
...est_password_challenge_response_request.py | 54 +
test/test_password_expiry_policy.py | 69 +
test/test_password_expiry_policy_request.py | 57 +
test/test_password_policy.py | 79 +
test/test_password_policy_request.py | 67 +
test/test_password_stage.py | 102 +
test/test_password_stage_request.py | 62 +
..._patched_account_lockdown_stage_request.py | 57 +
test/test_patched_agent_connector_request.py | 67 +
...pple_independent_secure_enclave_request.py | 56 +
...patched_application_entitlement_request.py | 56 +
test/test_patched_application_request.py | 65 +
...patched_authenticator_duo_stage_request.py | 59 +
...tched_authenticator_email_stage_request.py | 66 +
...thenticator_endpoint_gdtc_stage_request.py | 57 +
...patched_authenticator_sms_stage_request.py | 62 +
...ched_authenticator_static_stage_request.py | 56 +
...atched_authenticator_totp_stage_request.py | 55 +
...ed_authenticator_validate_stage_request.py | 71 +
...d_authenticator_web_authn_stage_request.py | 65 +
...test_patched_blueprint_instance_request.py | 58 +
test/test_patched_brand_request.py | 73 +
test/test_patched_captcha_stage_request.py | 60 +
...st_patched_certificate_key_pair_request.py | 54 +
test/test_patched_connection_token_request.py | 54 +
test/test_patched_consent_stage_request.py | 54 +
test/test_patched_deny_stage_request.py | 53 +
...est_patched_device_access_group_request.py | 55 +
...est_patched_device_user_binding_request.py | 61 +
...tched_docker_service_connection_request.py | 56 +
test/test_patched_domain_request.py | 54 +
test/test_patched_dummy_policy_request.py | 56 +
test/test_patched_dummy_stage_request.py | 53 +
test/test_patched_duo_device_request.py | 52 +
test/test_patched_email_device_request.py | 52 +
test/test_patched_email_stage_request.py | 67 +
test/test_patched_endpoint_device_request.py | 64 +
test/test_patched_endpoint_request.py | 63 +
test/test_patched_endpoint_stage_request.py | 54 +
test/test_patched_enrollment_token_request.py | 56 +
...st_patched_event_matcher_policy_request.py | 58 +
test/test_patched_event_request.py | 64 +
.../test_patched_expression_policy_request.py | 54 +
test/test_patched_fleet_connector_request.py | 59 +
test/test_patched_flow_request.py | 61 +
...test_patched_flow_stage_binding_request.py | 58 +
test/test_patched_geo_ip_policy_request.py | 65 +
...patched_google_chrome_connector_request.py | 57 +
..._patched_google_endpoint_device_request.py | 53 +
...ogle_workspace_provider_mapping_request.py | 54 +
...tched_google_workspace_provider_request.py | 71 +
...roup_kerberos_source_connection_request.py | 54 +
...ed_group_ldap_source_connection_request.py | 54 +
..._group_o_auth_source_connection_request.py | 54 +
...ed_group_plex_source_connection_request.py | 54 +
test/test_patched_group_request.py | 65 +
...ed_group_saml_source_connection_request.py | 54 +
...patched_group_source_connection_request.py | 54 +
...roup_telegram_source_connection_request.py | 54 +
...st_patched_identification_stage_request.py | 69 +
...est_patched_initial_permissions_request.py | 56 +
test/test_patched_invitation_request.py | 58 +
test/test_patched_invitation_stage_request.py | 53 +
...erberos_source_property_mapping_request.py | 54 +
test/test_patched_kerberos_source_request.py | 82 +
...d_kubernetes_service_connection_request.py | 57 +
test/test_patched_ldap_provider_request.py | 66 +
...ed_ldap_source_property_mapping_request.py | 54 +
test/test_patched_ldap_source_request.py | 90 +
test/test_patched_license_request.py | 52 +
test/test_patched_lifecycle_rule_request.py | 67 +
...icrosoft_entra_provider_mapping_request.py | 54 +
...atched_microsoft_entra_provider_request.py | 68 +
test/test_patched_mutual_tls_stage_request.py | 58 +
test/test_patched_notification_request.py | 68 +
.../test_patched_notification_rule_request.py | 58 +
..._patched_notification_transport_request.py | 60 +
...ed_notification_webhook_mapping_request.py | 53 +
test/test_patched_o_auth2_provider_request.py | 87 +
..._o_auth_source_property_mapping_request.py | 54 +
test/test_patched_o_auth_source_request.py | 83 +
test/test_patched_outpost_request.py | 61 +
..._patched_password_expiry_policy_request.py | 55 +
test/test_patched_password_policy_request.py | 66 +
test/test_patched_password_stage_request.py | 58 +
.../test_patched_permission_assign_request.py | 56 +
...ed_plex_source_property_mapping_request.py | 54 +
test/test_patched_plex_source_request.py | 74 +
test/test_patched_policy_binding_request.py | 60 +
test/test_patched_prompt_request.py | 62 +
test/test_patched_prompt_stage_request.py | 58 +
test/test_patched_proxy_provider_request.py | 77 +
...st_patched_rac_property_mapping_request.py | 57 +
test/test_patched_rac_provider_request.py | 62 +
...adius_provider_property_mapping_request.py | 54 +
test/test_patched_radius_provider_request.py | 62 +
test/test_patched_redirect_stage_request.py | 56 +
.../test_patched_reputation_policy_request.py | 56 +
test/test_patched_role_request.py | 52 +
...t_patched_saml_property_mapping_request.py | 56 +
test/test_patched_saml_provider_request.py | 81 +
...ed_saml_source_property_mapping_request.py | 54 +
test/test_patched_saml_source_request.py | 84 +
test/test_patched_schedule_request.py | 54 +
test/test_patched_scim_mapping_request.py | 54 +
test/test_patched_scim_provider_request.py | 75 +
.../test_patched_scim_source_group_request.py | 58 +
...ed_scim_source_property_mapping_request.py | 54 +
test/test_patched_scim_source_request.py | 61 +
test/test_patched_scim_source_user_request.py | 58 +
test/test_patched_scope_mapping_request.py | 56 +
test/test_patched_settings_request.py | 71 +
test/test_patched_settings_request_flags.py | 59 +
test/test_patched_sms_device_request.py | 52 +
test/test_patched_source_stage_request.py | 54 +
test/test_patched_ssf_provider_request.py | 58 +
test/test_patched_static_device_request.py | 52 +
...elegram_source_property_mapping_request.py | 54 +
test/test_patched_telegram_source_request.py | 71 +
test/test_patched_tenant_request.py | 54 +
test/test_patched_token_request.py | 58 +
test/test_patched_totp_device_request.py | 52 +
..._patched_unique_password_policy_request.py | 55 +
.../test_patched_user_delete_stage_request.py | 52 +
...user_kerberos_source_connection_request.py | 54 +
...hed_user_ldap_source_connection_request.py | 54 +
test/test_patched_user_login_stage_request.py | 58 +
.../test_patched_user_logout_stage_request.py | 52 +
...d_user_o_auth_source_connection_request.py | 56 +
...hed_user_plex_source_connection_request.py | 55 +
test/test_patched_user_request.py | 67 +
...hed_user_saml_source_connection_request.py | 54 +
..._patched_user_source_connection_request.py | 54 +
...user_telegram_source_connection_request.py | 54 +
test/test_patched_user_write_stage_request.py | 57 +
test/test_patched_web_authn_device_request.py | 52 +
..._patched_ws_federation_provider_request.py | 72 +
test/test_permission.py | 65 +
test/test_permission_assign_request.py | 59 +
test/test_permission_assign_result.py | 53 +
test/test_pkce_method_enum.py | 34 +
test/test_plex_authentication_challenge.py | 69 +
...thentication_challenge_response_request.py | 52 +
test/test_plex_source.py | 97 +
test/test_plex_source_property_mapping.py | 66 +
...st_plex_source_property_mapping_request.py | 56 +
test/test_plex_source_request.py | 77 +
test/test_plex_token_redeem_request.py | 53 +
test/test_policies_api.py | 488 +
test/test_policy.py | 66 +
test/test_policy_binding.py | 120 +
test/test_policy_binding_request.py | 62 +
test/test_policy_engine_mode.py | 34 +
test/test_policy_test_request.py | 56 +
test/test_policy_test_result.py | 79 +
test/test_process.py | 56 +
test/test_process_request.py | 56 +
test/test_prompt.py | 128 +
test/test_prompt_challenge.py | 97 +
.../test_prompt_challenge_response_request.py | 52 +
test/test_prompt_choice.py | 55 +
test/test_prompt_request.py | 66 +
test/test_prompt_stage.py | 102 +
test/test_prompt_stage_request.py | 62 +
test/test_prompt_type_enum.py | 34 +
test/test_property_mapping.py | 66 +
test/test_property_mapping_preview.py | 57 +
test/test_property_mapping_test_request.py | 56 +
test/test_property_mapping_test_result.py | 55 +
test/test_propertymappings_api.py | 698 +
test/test_protocol_enum.py | 34 +
test/test_provider.py | 79 +
test/test_provider_enum.py | 34 +
test/test_provider_model_enum.py | 34 +
test/test_provider_type_enum.py | 34 +
test/test_providers_api.py | 782 +
test/test_proxy_mode.py | 34 +
test/test_proxy_outpost_config.py | 122 +
test/test_proxy_provider.py | 119 +
test/test_proxy_provider_request.py | 81 +
test/test_rac_api.py | 110 +
test/test_rac_property_mapping.py | 71 +
test/test_rac_property_mapping_request.py | 61 +
test/test_rac_provider.py | 88 +
test/test_rac_provider_request.py | 64 +
test/test_radius_check_access.py | 82 +
test/test_radius_outpost_config.py | 63 +
test/test_radius_provider.py | 89 +
test/test_radius_provider_property_mapping.py | 66 +
...adius_provider_property_mapping_request.py | 56 +
test/test_radius_provider_request.py | 65 +
test/test_rbac_api.py | 164 +
test/test_redirect_challenge.py | 67 +
...est_redirect_challenge_response_request.py | 54 +
test/test_redirect_stage.py | 98 +
test/test_redirect_stage_mode_enum.py | 34 +
test/test_redirect_stage_request.py | 58 +
test/test_redirect_uri.py | 56 +
test/test_redirect_uri_request.py | 56 +
test/test_redirect_uri_type_enum.py | 34 +
test/test_related_group.py | 61 +
test/test_related_rule.py | 80 +
test/test_reports_api.py | 50 +
test/test_reputation.py | 65 +
test/test_reputation_policy.py | 69 +
test/test_reputation_policy_request.py | 57 +
test/test_review.py | 68 +
test/test_review_request.py | 54 +
test/test_reviewer_group.py | 55 +
test/test_reviewer_user.py | 59 +
test/test_role.py | 55 +
test/test_role_assigned_object_permission.py | 89 +
test/test_role_model_permission.py | 61 +
test/test_role_object_permission.py | 63 +
test/test_role_request.py | 53 +
test/test_root_api.py | 38 +
test/test_saml_bindings_enum.py | 34 +
test/test_saml_logout_methods.py | 34 +
test/test_saml_metadata.py | 54 +
test/test_saml_name_id_policy_enum.py | 34 +
test/test_saml_property_mapping.py | 69 +
test/test_saml_property_mapping_request.py | 59 +
test/test_saml_provider.py | 121 +
test/test_saml_provider_request.py | 85 +
test/test_saml_source.py | 108 +
test/test_saml_source_property_mapping.py | 66 +
...st_saml_source_property_mapping_request.py | 56 +
test/test_saml_source_request.py | 88 +
test/test_schedule.py | 73 +
test/test_schedule_request.py | 55 +
test/test_schema_api.py | 38 +
test/test_scim_authentication_mode_enum.py | 34 +
test/test_scim_mapping.py | 66 +
test/test_scim_mapping_request.py | 56 +
test/test_scim_provider.py | 91 +
test/test_scim_provider_group.py | 81 +
test/test_scim_provider_group_request.py | 57 +
test/test_scim_provider_request.py | 77 +
test/test_scim_provider_user.py | 87 +
test/test_scim_provider_user_request.py | 57 +
test/test_scim_source.py | 97 +
test/test_scim_source_group.py | 77 +
test/test_scim_source_group_request.py | 61 +
test/test_scim_source_property_mapping.py | 66 +
...st_scim_source_property_mapping_request.py | 56 +
test/test_scim_source_request.py | 63 +
test/test_scim_source_user.py | 83 +
test/test_scim_source_user_request.py | 61 +
test/test_scope_mapping.py | 69 +
test/test_scope_mapping_request.py | 59 +
test/test_selectable_stage.py | 59 +
test/test_service_connection.py | 64 +
test/test_service_connection_state.py | 55 +
test/test_session_end_challenge.py | 74 +
test/test_session_user.py | 129 +
test/test_settings.py | 76 +
test/test_settings_request.py | 76 +
test/test_severity_enum.py | 34 +
test/test_shell_challenge.py | 67 +
test/test_signature_algorithm_enum.py | 34 +
test/test_sms_device.py | 79 +
test/test_sms_device_request.py | 53 +
test/test_software.py | 57 +
test/test_software_request.py | 57 +
test/test_source.py | 89 +
test/test_source_stage.py | 96 +
test/test_source_stage_request.py | 56 +
test/test_source_type.py | 69 +
test/test_sources_api.py | 1070 +
test/test_ssf_api.py | 50 +
test/test_ssf_provider.py | 130 +
test/test_ssf_provider_request.py | 60 +
test/test_ssf_stream.py | 137 +
test/test_ssf_stream_status_enum.py | 34 +
test/test_stage.py | 93 +
test/test_stage_mode_enum.py | 34 +
test/test_stage_prompt.py | 77 +
test/test_stages_api.py | 1292 +
test/test_static_device.py | 85 +
test/test_static_device_request.py | 53 +
test/test_static_device_token.py | 53 +
test/test_sub_mode_enum.py | 34 +
test/test_sync_object_model_enum.py | 34 +
test/test_sync_object_request.py | 56 +
test/test_sync_object_result.py | 71 +
test/test_sync_outgoing_trigger_mode_enum.py | 34 +
test/test_sync_status.py | 55 +
test/test_system_info.py | 87 +
test/test_system_info_runtime.py | 67 +
test/test_task.py | 110 +
test/test_task_aggregated_status_enum.py | 34 +
test/test_task_status_enum.py | 34 +
test/test_tasks_api.py | 92 +
test/test_telegram_auth_request.py | 61 +
...est_telegram_challenge_response_request.py | 62 +
test/test_telegram_login_challenge.py | 69 +
test/test_telegram_source.py | 94 +
test/test_telegram_source_property_mapping.py | 66 +
...elegram_source_property_mapping_request.py | 56 +
test/test_telegram_source_request.py | 76 +
test/test_tenant.py | 58 +
...test_tenant_admin_group_request_request.py | 53 +
...est_tenant_recovery_key_request_request.py | 55 +
test/test_tenant_recovery_key_response.py | 55 +
test/test_tenant_request.py | 56 +
test/test_tenants_api.py | 116 +
test/test_themed_urls.py | 53 +
test/test_token.py | 141 +
test/test_token_model.py | 237 +
test/test_token_request.py | 59 +
test/test_token_set_key_request.py | 53 +
test/test_token_view.py | 53 +
test/test_totp_device.py | 77 +
test/test_totp_device_request.py | 53 +
test/test_transaction_application_request.py | 96 +
test/test_transaction_application_response.py | 59 +
...test_transaction_policy_binding_request.py | 60 +
test/test_transport_mode_enum.py | 34 +
test/test_type_create.py | 62 +
test/test_ui_theme_enum.py | 34 +
test/test_unique_password_policy.py | 68 +
test/test_unique_password_policy_request.py | 56 +
test/test_usage_enum.py | 34 +
test/test_used_by.py | 61 +
test/test_used_by_action_enum.py | 34 +
test/test_user.py | 115 +
test/test_user_account_lockdown_request.py | 52 +
test/test_user_account_request.py | 53 +
...ser_account_serializer_for_role_request.py | 53 +
test/test_user_attribute_enum.py | 34 +
test/test_user_consent.py | 214 +
test/test_user_creation_mode_enum.py | 34 +
test/test_user_delete_stage.py | 93 +
test/test_user_delete_stage_request.py | 53 +
test/test_user_fields_enum.py | 34 +
test/test_user_kerberos_source_connection.py | 113 +
...user_kerberos_source_connection_request.py | 57 +
test/test_user_ldap_source_connection.py | 135 +
...est_user_ldap_source_connection_request.py | 57 +
test/test_user_login_challenge.py | 69 +
...t_user_login_challenge_response_request.py | 54 +
test/test_user_login_stage.py | 99 +
test/test_user_login_stage_request.py | 59 +
test/test_user_logout_stage.py | 93 +
test/test_user_logout_stage_request.py | 53 +
test/test_user_matching_mode_enum.py | 34 +
test/test_user_o_auth_source_connection.py | 114 +
...t_user_o_auth_source_connection_request.py | 59 +
test/test_user_password_hash_set_request.py | 53 +
test/test_user_password_set_request.py | 53 +
test/test_user_path.py | 57 +
test/test_user_plex_source_connection.py | 113 +
...est_user_plex_source_connection_request.py | 59 +
test/test_user_recovery_email_request.py | 54 +
test/test_user_recovery_link_request.py | 52 +
test/test_user_request.py | 69 +
test/test_user_saml_source_connection.py | 113 +
...est_user_saml_source_connection_request.py | 57 +
test/test_user_self.py | 99 +
test/test_user_self_groups.py | 55 +
test/test_user_self_roles.py | 55 +
test/test_user_service_account_request.py | 56 +
test/test_user_service_account_response.py | 60 +
test/test_user_setting.py | 59 +
test/test_user_source_connection.py | 113 +
test/test_user_source_connection_request.py | 57 +
test/test_user_telegram_source_connection.py | 113 +
...user_telegram_source_connection_request.py | 57 +
test/test_user_type_enum.py | 34 +
test/test_user_verification_enum.py | 34 +
test/test_user_write_stage.py | 98 +
test/test_user_write_stage_request.py | 58 +
test/test_validation_error.py | 55 +
test/test_vendor_enum.py | 34 +
test/test_version.py | 63 +
test/test_version_history.py | 59 +
test/test_web_authn_device.py | 87 +
test/test_web_authn_device_request.py | 53 +
test/test_web_authn_device_type.py | 55 +
test/test_web_authn_hint_enum.py | 34 +
test/test_worker.py | 57 +
test/test_ws_federation_provider.py | 99 +
test/test_ws_federation_provider_request.py | 77 +
tox.ini | 9 +
2745 files changed, 699084 insertions(+), 1 deletion(-)
create mode 100644 .gitignore
create mode 100644 .openapi-generator/FILES
create mode 100644 .openapi-generator/VERSION
create mode 100644 authentik_client/__init__.py
create mode 100644 authentik_client/api/__init__.py
create mode 100644 authentik_client/api/admin_api.py
create mode 100644 authentik_client/api/authenticators_api.py
create mode 100644 authentik_client/api/core_api.py
create mode 100644 authentik_client/api/crypto_api.py
create mode 100644 authentik_client/api/endpoints_api.py
create mode 100644 authentik_client/api/enterprise_api.py
create mode 100644 authentik_client/api/events_api.py
create mode 100644 authentik_client/api/flows_api.py
create mode 100644 authentik_client/api/lifecycle_api.py
create mode 100644 authentik_client/api/managed_api.py
create mode 100644 authentik_client/api/oauth2_api.py
create mode 100644 authentik_client/api/outposts_api.py
create mode 100644 authentik_client/api/policies_api.py
create mode 100644 authentik_client/api/propertymappings_api.py
create mode 100644 authentik_client/api/providers_api.py
create mode 100644 authentik_client/api/rac_api.py
create mode 100644 authentik_client/api/rbac_api.py
create mode 100644 authentik_client/api/reports_api.py
create mode 100644 authentik_client/api/root_api.py
create mode 100644 authentik_client/api/schema_api.py
create mode 100644 authentik_client/api/sources_api.py
create mode 100644 authentik_client/api/ssf_api.py
create mode 100644 authentik_client/api/stages_api.py
create mode 100644 authentik_client/api/tasks_api.py
create mode 100644 authentik_client/api/tenants_api.py
create mode 100644 authentik_client/api_client.py
create mode 100644 authentik_client/api_response.py
create mode 100644 authentik_client/configuration.py
create mode 100644 authentik_client/exceptions.py
create mode 100644 authentik_client/models/__init__.py
create mode 100644 authentik_client/models/access_denied_challenge.py
create mode 100644 authentik_client/models/account_lockdown_stage.py
create mode 100644 authentik_client/models/account_lockdown_stage_request.py
create mode 100644 authentik_client/models/agent_authentication_response.py
create mode 100644 authentik_client/models/agent_config.py
create mode 100644 authentik_client/models/agent_connector.py
create mode 100644 authentik_client/models/agent_connector_request.py
create mode 100644 authentik_client/models/agent_psso_device_registration_request.py
create mode 100644 authentik_client/models/agent_psso_device_registration_response.py
create mode 100644 authentik_client/models/agent_psso_user_registration_request.py
create mode 100644 authentik_client/models/agent_token_response.py
create mode 100644 authentik_client/models/alg_enum.py
create mode 100644 authentik_client/models/app.py
create mode 100644 authentik_client/models/app_enum.py
create mode 100644 authentik_client/models/apple_challenge_response_request.py
create mode 100644 authentik_client/models/apple_independent_secure_enclave.py
create mode 100644 authentik_client/models/apple_independent_secure_enclave_request.py
create mode 100644 authentik_client/models/apple_login_challenge.py
create mode 100644 authentik_client/models/application.py
create mode 100644 authentik_client/models/application_entitlement.py
create mode 100644 authentik_client/models/application_entitlement_request.py
create mode 100644 authentik_client/models/application_request.py
create mode 100644 authentik_client/models/auth_type_enum.py
create mode 100644 authentik_client/models/authenticated_session.py
create mode 100644 authentik_client/models/authenticated_session_asn.py
create mode 100644 authentik_client/models/authenticated_session_geo_ip.py
create mode 100644 authentik_client/models/authenticated_session_user_agent.py
create mode 100644 authentik_client/models/authenticated_session_user_agent_device.py
create mode 100644 authentik_client/models/authenticated_session_user_agent_os.py
create mode 100644 authentik_client/models/authenticated_session_user_agent_user_agent.py
create mode 100644 authentik_client/models/authentication_enum.py
create mode 100644 authentik_client/models/authenticator_attachment_enum.py
create mode 100644 authentik_client/models/authenticator_duo_challenge.py
create mode 100644 authentik_client/models/authenticator_duo_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_duo_stage.py
create mode 100644 authentik_client/models/authenticator_duo_stage_device_import_response.py
create mode 100644 authentik_client/models/authenticator_duo_stage_manual_device_import_request.py
create mode 100644 authentik_client/models/authenticator_duo_stage_request.py
create mode 100644 authentik_client/models/authenticator_email_challenge.py
create mode 100644 authentik_client/models/authenticator_email_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_email_stage.py
create mode 100644 authentik_client/models/authenticator_email_stage_request.py
create mode 100644 authentik_client/models/authenticator_endpoint_gdtc_stage.py
create mode 100644 authentik_client/models/authenticator_endpoint_gdtc_stage_request.py
create mode 100644 authentik_client/models/authenticator_sms_challenge.py
create mode 100644 authentik_client/models/authenticator_sms_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_sms_stage.py
create mode 100644 authentik_client/models/authenticator_sms_stage_request.py
create mode 100644 authentik_client/models/authenticator_static_challenge.py
create mode 100644 authentik_client/models/authenticator_static_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_static_stage.py
create mode 100644 authentik_client/models/authenticator_static_stage_request.py
create mode 100644 authentik_client/models/authenticator_totp_challenge.py
create mode 100644 authentik_client/models/authenticator_totp_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_totp_stage.py
create mode 100644 authentik_client/models/authenticator_totp_stage_request.py
create mode 100644 authentik_client/models/authenticator_validate_stage.py
create mode 100644 authentik_client/models/authenticator_validate_stage_request.py
create mode 100644 authentik_client/models/authenticator_validation_challenge.py
create mode 100644 authentik_client/models/authenticator_validation_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_web_authn_challenge.py
create mode 100644 authentik_client/models/authenticator_web_authn_challenge_response_request.py
create mode 100644 authentik_client/models/authenticator_web_authn_stage.py
create mode 100644 authentik_client/models/authenticator_web_authn_stage_request.py
create mode 100644 authentik_client/models/authorization_code_auth_method_enum.py
create mode 100644 authentik_client/models/auto_submit_challenge_response_request.py
create mode 100644 authentik_client/models/autosubmit_challenge.py
create mode 100644 authentik_client/models/backends_enum.py
create mode 100644 authentik_client/models/binding_type_enum.py
create mode 100644 authentik_client/models/blueprint_file.py
create mode 100644 authentik_client/models/blueprint_import_result.py
create mode 100644 authentik_client/models/blueprint_instance.py
create mode 100644 authentik_client/models/blueprint_instance_request.py
create mode 100644 authentik_client/models/blueprint_instance_status_enum.py
create mode 100644 authentik_client/models/brand.py
create mode 100644 authentik_client/models/brand_request.py
create mode 100644 authentik_client/models/bulk_delete_session_response.py
create mode 100644 authentik_client/models/cache.py
create mode 100644 authentik_client/models/capabilities_enum.py
create mode 100644 authentik_client/models/captcha_challenge.py
create mode 100644 authentik_client/models/captcha_challenge_response_request.py
create mode 100644 authentik_client/models/captcha_stage.py
create mode 100644 authentik_client/models/captcha_stage_request.py
create mode 100644 authentik_client/models/cert_attribute_enum.py
create mode 100644 authentik_client/models/certificate_data.py
create mode 100644 authentik_client/models/certificate_generation_request.py
create mode 100644 authentik_client/models/certificate_key_pair.py
create mode 100644 authentik_client/models/certificate_key_pair_key_type_enum.py
create mode 100644 authentik_client/models/certificate_key_pair_request.py
create mode 100644 authentik_client/models/challenge_types.py
create mode 100644 authentik_client/models/client_type_enum.py
create mode 100644 authentik_client/models/compatibility_mode_enum.py
create mode 100644 authentik_client/models/config.py
create mode 100644 authentik_client/models/connection_token.py
create mode 100644 authentik_client/models/connection_token_request.py
create mode 100644 authentik_client/models/connector.py
create mode 100644 authentik_client/models/consent_challenge.py
create mode 100644 authentik_client/models/consent_challenge_response_request.py
create mode 100644 authentik_client/models/consent_mode_enum.py
create mode 100644 authentik_client/models/consent_permission.py
create mode 100644 authentik_client/models/consent_stage.py
create mode 100644 authentik_client/models/consent_stage_request.py
create mode 100644 authentik_client/models/content_type.py
create mode 100644 authentik_client/models/content_type_enum.py
create mode 100644 authentik_client/models/contextual_flow_info.py
create mode 100644 authentik_client/models/contextual_flow_info_layout_enum.py
create mode 100644 authentik_client/models/country_code_enum.py
create mode 100644 authentik_client/models/current_brand.py
create mode 100644 authentik_client/models/current_brand_flags.py
create mode 100644 authentik_client/models/data_export.py
create mode 100644 authentik_client/models/delivery_method_enum.py
create mode 100644 authentik_client/models/denied_action_enum.py
create mode 100644 authentik_client/models/deny_stage.py
create mode 100644 authentik_client/models/deny_stage_request.py
create mode 100644 authentik_client/models/detailed_country.py
create mode 100644 authentik_client/models/device.py
create mode 100644 authentik_client/models/device_access_group.py
create mode 100644 authentik_client/models/device_access_group_request.py
create mode 100644 authentik_client/models/device_challenge.py
create mode 100644 authentik_client/models/device_challenge_request.py
create mode 100644 authentik_client/models/device_classes_enum.py
create mode 100644 authentik_client/models/device_connection.py
create mode 100644 authentik_client/models/device_fact_snapshot.py
create mode 100644 authentik_client/models/device_facts.py
create mode 100644 authentik_client/models/device_facts_os_family.py
create mode 100644 authentik_client/models/device_facts_request.py
create mode 100644 authentik_client/models/device_group.py
create mode 100644 authentik_client/models/device_group_request.py
create mode 100644 authentik_client/models/device_summary.py
create mode 100644 authentik_client/models/device_user.py
create mode 100644 authentik_client/models/device_user_binding.py
create mode 100644 authentik_client/models/device_user_binding_request.py
create mode 100644 authentik_client/models/device_user_request.py
create mode 100644 authentik_client/models/digest_algorithm_enum.py
create mode 100644 authentik_client/models/digits_enum.py
create mode 100644 authentik_client/models/disk.py
create mode 100644 authentik_client/models/disk_request.py
create mode 100644 authentik_client/models/docker_service_connection.py
create mode 100644 authentik_client/models/docker_service_connection_request.py
create mode 100644 authentik_client/models/domain.py
create mode 100644 authentik_client/models/domain_request.py
create mode 100644 authentik_client/models/dummy_challenge.py
create mode 100644 authentik_client/models/dummy_challenge_response_request.py
create mode 100644 authentik_client/models/dummy_policy.py
create mode 100644 authentik_client/models/dummy_policy_request.py
create mode 100644 authentik_client/models/dummy_stage.py
create mode 100644 authentik_client/models/dummy_stage_request.py
create mode 100644 authentik_client/models/duo_device.py
create mode 100644 authentik_client/models/duo_device_enrollment_status.py
create mode 100644 authentik_client/models/duo_device_request.py
create mode 100644 authentik_client/models/duo_response_enum.py
create mode 100644 authentik_client/models/email_challenge.py
create mode 100644 authentik_client/models/email_challenge_response_request.py
create mode 100644 authentik_client/models/email_device.py
create mode 100644 authentik_client/models/email_device_request.py
create mode 100644 authentik_client/models/email_stage.py
create mode 100644 authentik_client/models/email_stage_request.py
create mode 100644 authentik_client/models/endpoint.py
create mode 100644 authentik_client/models/endpoint_agent_challenge.py
create mode 100644 authentik_client/models/endpoint_agent_challenge_response_request.py
create mode 100644 authentik_client/models/endpoint_auth_mode_enum.py
create mode 100644 authentik_client/models/endpoint_device.py
create mode 100644 authentik_client/models/endpoint_device_details.py
create mode 100644 authentik_client/models/endpoint_device_request.py
create mode 100644 authentik_client/models/endpoint_request.py
create mode 100644 authentik_client/models/endpoint_stage.py
create mode 100644 authentik_client/models/endpoint_stage_request.py
create mode 100644 authentik_client/models/enroll_request.py
create mode 100644 authentik_client/models/enrollment_token.py
create mode 100644 authentik_client/models/enrollment_token_request.py
create mode 100644 authentik_client/models/error_detail.py
create mode 100644 authentik_client/models/error_reporting_config.py
create mode 100644 authentik_client/models/event.py
create mode 100644 authentik_client/models/event_actions.py
create mode 100644 authentik_client/models/event_matcher_policy.py
create mode 100644 authentik_client/models/event_matcher_policy_request.py
create mode 100644 authentik_client/models/event_request.py
create mode 100644 authentik_client/models/event_stats.py
create mode 100644 authentik_client/models/event_top_per_user.py
create mode 100644 authentik_client/models/event_volume.py
create mode 100644 authentik_client/models/events_requested_enum.py
create mode 100644 authentik_client/models/expiring_base_grant_model.py
create mode 100644 authentik_client/models/expression_policy.py
create mode 100644 authentik_client/models/expression_policy_request.py
create mode 100644 authentik_client/models/extra_role_object_permission.py
create mode 100644 authentik_client/models/file_list.py
create mode 100644 authentik_client/models/fleet_connector.py
create mode 100644 authentik_client/models/fleet_connector_request.py
create mode 100644 authentik_client/models/flow.py
create mode 100644 authentik_client/models/flow_challenge_response_request.py
create mode 100644 authentik_client/models/flow_designation_enum.py
create mode 100644 authentik_client/models/flow_diagram.py
create mode 100644 authentik_client/models/flow_error_challenge.py
create mode 100644 authentik_client/models/flow_inspection.py
create mode 100644 authentik_client/models/flow_inspector_plan.py
create mode 100644 authentik_client/models/flow_layout_enum.py
create mode 100644 authentik_client/models/flow_request.py
create mode 100644 authentik_client/models/flow_set.py
create mode 100644 authentik_client/models/flow_stage_binding.py
create mode 100644 authentik_client/models/flow_stage_binding_request.py
create mode 100644 authentik_client/models/footer_link.py
create mode 100644 authentik_client/models/force_binding_enum.py
create mode 100644 authentik_client/models/format_enum.py
create mode 100644 authentik_client/models/frame_challenge.py
create mode 100644 authentik_client/models/frame_challenge_response_request.py
create mode 100644 authentik_client/models/generic_error.py
create mode 100644 authentik_client/models/geo_ip_policy.py
create mode 100644 authentik_client/models/geo_ip_policy_countries_obj_inner.py
create mode 100644 authentik_client/models/geo_ip_policy_request.py
create mode 100644 authentik_client/models/geoip_binding_enum.py
create mode 100644 authentik_client/models/global_task_status.py
create mode 100644 authentik_client/models/google_chrome_connector.py
create mode 100644 authentik_client/models/google_chrome_connector_request.py
create mode 100644 authentik_client/models/google_endpoint_device.py
create mode 100644 authentik_client/models/google_endpoint_device_request.py
create mode 100644 authentik_client/models/google_workspace_provider.py
create mode 100644 authentik_client/models/google_workspace_provider_group.py
create mode 100644 authentik_client/models/google_workspace_provider_group_request.py
create mode 100644 authentik_client/models/google_workspace_provider_mapping.py
create mode 100644 authentik_client/models/google_workspace_provider_mapping_request.py
create mode 100644 authentik_client/models/google_workspace_provider_request.py
create mode 100644 authentik_client/models/google_workspace_provider_user.py
create mode 100644 authentik_client/models/google_workspace_provider_user_request.py
create mode 100644 authentik_client/models/grant_types_enum.py
create mode 100644 authentik_client/models/group.py
create mode 100644 authentik_client/models/group_kerberos_source_connection.py
create mode 100644 authentik_client/models/group_kerberos_source_connection_request.py
create mode 100644 authentik_client/models/group_ldap_source_connection.py
create mode 100644 authentik_client/models/group_ldap_source_connection_request.py
create mode 100644 authentik_client/models/group_matching_mode_enum.py
create mode 100644 authentik_client/models/group_o_auth_source_connection.py
create mode 100644 authentik_client/models/group_o_auth_source_connection_request.py
create mode 100644 authentik_client/models/group_plex_source_connection.py
create mode 100644 authentik_client/models/group_plex_source_connection_request.py
create mode 100644 authentik_client/models/group_request.py
create mode 100644 authentik_client/models/group_saml_source_connection.py
create mode 100644 authentik_client/models/group_saml_source_connection_request.py
create mode 100644 authentik_client/models/group_source_connection.py
create mode 100644 authentik_client/models/group_source_connection_request.py
create mode 100644 authentik_client/models/group_telegram_source_connection.py
create mode 100644 authentik_client/models/group_telegram_source_connection_request.py
create mode 100644 authentik_client/models/hardware.py
create mode 100644 authentik_client/models/hardware_request.py
create mode 100644 authentik_client/models/identification_challenge.py
create mode 100644 authentik_client/models/identification_challenge_response_request.py
create mode 100644 authentik_client/models/identification_stage.py
create mode 100644 authentik_client/models/identification_stage_request.py
create mode 100644 authentik_client/models/iframe_logout_challenge.py
create mode 100644 authentik_client/models/iframe_logout_challenge_response_request.py
create mode 100644 authentik_client/models/impersonation_request.py
create mode 100644 authentik_client/models/initial_permissions.py
create mode 100644 authentik_client/models/initial_permissions_request.py
create mode 100644 authentik_client/models/install_id.py
create mode 100644 authentik_client/models/intent_enum.py
create mode 100644 authentik_client/models/invalid_response_action_enum.py
create mode 100644 authentik_client/models/invitation.py
create mode 100644 authentik_client/models/invitation_request.py
create mode 100644 authentik_client/models/invitation_send_email_request.py
create mode 100644 authentik_client/models/invitation_stage.py
create mode 100644 authentik_client/models/invitation_stage_request.py
create mode 100644 authentik_client/models/issuer_mode_enum.py
create mode 100644 authentik_client/models/kadmin_type_enum.py
create mode 100644 authentik_client/models/kerberos_source.py
create mode 100644 authentik_client/models/kerberos_source_property_mapping.py
create mode 100644 authentik_client/models/kerberos_source_property_mapping_request.py
create mode 100644 authentik_client/models/kerberos_source_request.py
create mode 100644 authentik_client/models/key_type_enum.py
create mode 100644 authentik_client/models/kubernetes_service_connection.py
create mode 100644 authentik_client/models/kubernetes_service_connection_request.py
create mode 100644 authentik_client/models/lang_enum.py
create mode 100644 authentik_client/models/last_task_status_enum.py
create mode 100644 authentik_client/models/ldap_check_access.py
create mode 100644 authentik_client/models/ldap_debug.py
create mode 100644 authentik_client/models/ldap_outpost_config.py
create mode 100644 authentik_client/models/ldap_provider.py
create mode 100644 authentik_client/models/ldap_provider_request.py
create mode 100644 authentik_client/models/ldap_source.py
create mode 100644 authentik_client/models/ldap_source_property_mapping.py
create mode 100644 authentik_client/models/ldap_source_property_mapping_request.py
create mode 100644 authentik_client/models/ldap_source_request.py
create mode 100644 authentik_client/models/ldapapi_access_mode.py
create mode 100644 authentik_client/models/license.py
create mode 100644 authentik_client/models/license_flags_enum.py
create mode 100644 authentik_client/models/license_forecast.py
create mode 100644 authentik_client/models/license_request.py
create mode 100644 authentik_client/models/license_status_enum.py
create mode 100644 authentik_client/models/license_summary.py
create mode 100644 authentik_client/models/license_summary_status_enum.py
create mode 100644 authentik_client/models/lifecycle_iteration.py
create mode 100644 authentik_client/models/lifecycle_iteration_request.py
create mode 100644 authentik_client/models/lifecycle_iteration_state_enum.py
create mode 100644 authentik_client/models/lifecycle_rule.py
create mode 100644 authentik_client/models/lifecycle_rule_request.py
create mode 100644 authentik_client/models/link.py
create mode 100644 authentik_client/models/log_event.py
create mode 100644 authentik_client/models/log_level_enum.py
create mode 100644 authentik_client/models/login_challenge_types.py
create mode 100644 authentik_client/models/login_source.py
create mode 100644 authentik_client/models/logout_url.py
create mode 100644 authentik_client/models/matching_mode_enum.py
create mode 100644 authentik_client/models/mdm_config_request.py
create mode 100644 authentik_client/models/mdm_config_response.py
create mode 100644 authentik_client/models/metadata.py
create mode 100644 authentik_client/models/microsoft_entra_provider.py
create mode 100644 authentik_client/models/microsoft_entra_provider_group.py
create mode 100644 authentik_client/models/microsoft_entra_provider_group_request.py
create mode 100644 authentik_client/models/microsoft_entra_provider_mapping.py
create mode 100644 authentik_client/models/microsoft_entra_provider_mapping_request.py
create mode 100644 authentik_client/models/microsoft_entra_provider_request.py
create mode 100644 authentik_client/models/microsoft_entra_provider_user.py
create mode 100644 authentik_client/models/microsoft_entra_provider_user_request.py
create mode 100644 authentik_client/models/model_enum.py
create mode 100644 authentik_client/models/model_request.py
create mode 100644 authentik_client/models/mutual_tls_stage.py
create mode 100644 authentik_client/models/mutual_tls_stage_request.py
create mode 100644 authentik_client/models/native_logout_challenge.py
create mode 100644 authentik_client/models/native_logout_challenge_response_request.py
create mode 100644 authentik_client/models/network.py
create mode 100644 authentik_client/models/network_binding_enum.py
create mode 100644 authentik_client/models/network_interface.py
create mode 100644 authentik_client/models/network_interface_request.py
create mode 100644 authentik_client/models/network_request.py
create mode 100644 authentik_client/models/not_configured_action_enum.py
create mode 100644 authentik_client/models/notification.py
create mode 100644 authentik_client/models/notification_request.py
create mode 100644 authentik_client/models/notification_rule.py
create mode 100644 authentik_client/models/notification_rule_request.py
create mode 100644 authentik_client/models/notification_transport.py
create mode 100644 authentik_client/models/notification_transport_request.py
create mode 100644 authentik_client/models/notification_transport_test.py
create mode 100644 authentik_client/models/notification_webhook_mapping.py
create mode 100644 authentik_client/models/notification_webhook_mapping_request.py
create mode 100644 authentik_client/models/o_auth2_provider.py
create mode 100644 authentik_client/models/o_auth2_provider_logout_method_enum.py
create mode 100644 authentik_client/models/o_auth2_provider_request.py
create mode 100644 authentik_client/models/o_auth2_provider_setup_urls.py
create mode 100644 authentik_client/models/o_auth_device_code_challenge.py
create mode 100644 authentik_client/models/o_auth_device_code_challenge_response_request.py
create mode 100644 authentik_client/models/o_auth_device_code_finish_challenge.py
create mode 100644 authentik_client/models/o_auth_device_code_finish_challenge_response_request.py
create mode 100644 authentik_client/models/o_auth_source.py
create mode 100644 authentik_client/models/o_auth_source_property_mapping.py
create mode 100644 authentik_client/models/o_auth_source_property_mapping_request.py
create mode 100644 authentik_client/models/o_auth_source_request.py
create mode 100644 authentik_client/models/open_id_connect_configuration.py
create mode 100644 authentik_client/models/operating_system.py
create mode 100644 authentik_client/models/operating_system_request.py
create mode 100644 authentik_client/models/outgoing_sync_delete_action.py
create mode 100644 authentik_client/models/outpost.py
create mode 100644 authentik_client/models/outpost_default_config.py
create mode 100644 authentik_client/models/outpost_health.py
create mode 100644 authentik_client/models/outpost_request.py
create mode 100644 authentik_client/models/outpost_type_enum.py
create mode 100644 authentik_client/models/paginated_account_lockdown_stage_list.py
create mode 100644 authentik_client/models/paginated_agent_connector_list.py
create mode 100644 authentik_client/models/paginated_apple_independent_secure_enclave_list.py
create mode 100644 authentik_client/models/paginated_application_entitlement_list.py
create mode 100644 authentik_client/models/paginated_application_list.py
create mode 100644 authentik_client/models/paginated_authenticated_session_list.py
create mode 100644 authentik_client/models/paginated_authenticator_duo_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_email_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_endpoint_gdtc_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_sms_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_static_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_totp_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_validate_stage_list.py
create mode 100644 authentik_client/models/paginated_authenticator_web_authn_stage_list.py
create mode 100644 authentik_client/models/paginated_blueprint_instance_list.py
create mode 100644 authentik_client/models/paginated_brand_list.py
create mode 100644 authentik_client/models/paginated_captcha_stage_list.py
create mode 100644 authentik_client/models/paginated_certificate_key_pair_list.py
create mode 100644 authentik_client/models/paginated_connection_token_list.py
create mode 100644 authentik_client/models/paginated_connector_list.py
create mode 100644 authentik_client/models/paginated_consent_stage_list.py
create mode 100644 authentik_client/models/paginated_data_export_list.py
create mode 100644 authentik_client/models/paginated_deny_stage_list.py
create mode 100644 authentik_client/models/paginated_device_access_group_list.py
create mode 100644 authentik_client/models/paginated_device_user_binding_list.py
create mode 100644 authentik_client/models/paginated_docker_service_connection_list.py
create mode 100644 authentik_client/models/paginated_domain_list.py
create mode 100644 authentik_client/models/paginated_dummy_policy_list.py
create mode 100644 authentik_client/models/paginated_dummy_stage_list.py
create mode 100644 authentik_client/models/paginated_duo_device_list.py
create mode 100644 authentik_client/models/paginated_email_device_list.py
create mode 100644 authentik_client/models/paginated_email_stage_list.py
create mode 100644 authentik_client/models/paginated_endpoint_device_list.py
create mode 100644 authentik_client/models/paginated_endpoint_list.py
create mode 100644 authentik_client/models/paginated_endpoint_stage_list.py
create mode 100644 authentik_client/models/paginated_enrollment_token_list.py
create mode 100644 authentik_client/models/paginated_event_list.py
create mode 100644 authentik_client/models/paginated_event_matcher_policy_list.py
create mode 100644 authentik_client/models/paginated_expiring_base_grant_model_list.py
create mode 100644 authentik_client/models/paginated_expression_policy_list.py
create mode 100644 authentik_client/models/paginated_extra_role_object_permission_list.py
create mode 100644 authentik_client/models/paginated_fleet_connector_list.py
create mode 100644 authentik_client/models/paginated_flow_list.py
create mode 100644 authentik_client/models/paginated_flow_stage_binding_list.py
create mode 100644 authentik_client/models/paginated_geo_ip_policy_list.py
create mode 100644 authentik_client/models/paginated_google_chrome_connector_list.py
create mode 100644 authentik_client/models/paginated_google_endpoint_device_list.py
create mode 100644 authentik_client/models/paginated_google_workspace_provider_group_list.py
create mode 100644 authentik_client/models/paginated_google_workspace_provider_list.py
create mode 100644 authentik_client/models/paginated_google_workspace_provider_mapping_list.py
create mode 100644 authentik_client/models/paginated_google_workspace_provider_user_list.py
create mode 100644 authentik_client/models/paginated_group_kerberos_source_connection_list.py
create mode 100644 authentik_client/models/paginated_group_ldap_source_connection_list.py
create mode 100644 authentik_client/models/paginated_group_list.py
create mode 100644 authentik_client/models/paginated_group_o_auth_source_connection_list.py
create mode 100644 authentik_client/models/paginated_group_plex_source_connection_list.py
create mode 100644 authentik_client/models/paginated_group_saml_source_connection_list.py
create mode 100644 authentik_client/models/paginated_group_source_connection_list.py
create mode 100644 authentik_client/models/paginated_group_telegram_source_connection_list.py
create mode 100644 authentik_client/models/paginated_identification_stage_list.py
create mode 100644 authentik_client/models/paginated_initial_permissions_list.py
create mode 100644 authentik_client/models/paginated_invitation_list.py
create mode 100644 authentik_client/models/paginated_invitation_stage_list.py
create mode 100644 authentik_client/models/paginated_kerberos_source_list.py
create mode 100644 authentik_client/models/paginated_kerberos_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_kubernetes_service_connection_list.py
create mode 100644 authentik_client/models/paginated_ldap_outpost_config_list.py
create mode 100644 authentik_client/models/paginated_ldap_provider_list.py
create mode 100644 authentik_client/models/paginated_ldap_source_list.py
create mode 100644 authentik_client/models/paginated_ldap_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_license_list.py
create mode 100644 authentik_client/models/paginated_lifecycle_iteration_list.py
create mode 100644 authentik_client/models/paginated_lifecycle_rule_list.py
create mode 100644 authentik_client/models/paginated_microsoft_entra_provider_group_list.py
create mode 100644 authentik_client/models/paginated_microsoft_entra_provider_list.py
create mode 100644 authentik_client/models/paginated_microsoft_entra_provider_mapping_list.py
create mode 100644 authentik_client/models/paginated_microsoft_entra_provider_user_list.py
create mode 100644 authentik_client/models/paginated_mutual_tls_stage_list.py
create mode 100644 authentik_client/models/paginated_notification_list.py
create mode 100644 authentik_client/models/paginated_notification_rule_list.py
create mode 100644 authentik_client/models/paginated_notification_transport_list.py
create mode 100644 authentik_client/models/paginated_notification_webhook_mapping_list.py
create mode 100644 authentik_client/models/paginated_o_auth2_provider_list.py
create mode 100644 authentik_client/models/paginated_o_auth_source_list.py
create mode 100644 authentik_client/models/paginated_o_auth_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_outpost_list.py
create mode 100644 authentik_client/models/paginated_password_expiry_policy_list.py
create mode 100644 authentik_client/models/paginated_password_policy_list.py
create mode 100644 authentik_client/models/paginated_password_stage_list.py
create mode 100644 authentik_client/models/paginated_permission_list.py
create mode 100644 authentik_client/models/paginated_plex_source_list.py
create mode 100644 authentik_client/models/paginated_plex_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_policy_binding_list.py
create mode 100644 authentik_client/models/paginated_policy_list.py
create mode 100644 authentik_client/models/paginated_prompt_list.py
create mode 100644 authentik_client/models/paginated_prompt_stage_list.py
create mode 100644 authentik_client/models/paginated_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_provider_list.py
create mode 100644 authentik_client/models/paginated_proxy_outpost_config_list.py
create mode 100644 authentik_client/models/paginated_proxy_provider_list.py
create mode 100644 authentik_client/models/paginated_rac_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_rac_provider_list.py
create mode 100644 authentik_client/models/paginated_radius_outpost_config_list.py
create mode 100644 authentik_client/models/paginated_radius_provider_list.py
create mode 100644 authentik_client/models/paginated_radius_provider_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_redirect_stage_list.py
create mode 100644 authentik_client/models/paginated_reputation_list.py
create mode 100644 authentik_client/models/paginated_reputation_policy_list.py
create mode 100644 authentik_client/models/paginated_role_assigned_object_permission_list.py
create mode 100644 authentik_client/models/paginated_role_list.py
create mode 100644 authentik_client/models/paginated_saml_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_saml_provider_list.py
create mode 100644 authentik_client/models/paginated_saml_source_list.py
create mode 100644 authentik_client/models/paginated_saml_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_schedule_list.py
create mode 100644 authentik_client/models/paginated_scim_mapping_list.py
create mode 100644 authentik_client/models/paginated_scim_provider_group_list.py
create mode 100644 authentik_client/models/paginated_scim_provider_list.py
create mode 100644 authentik_client/models/paginated_scim_provider_user_list.py
create mode 100644 authentik_client/models/paginated_scim_source_group_list.py
create mode 100644 authentik_client/models/paginated_scim_source_list.py
create mode 100644 authentik_client/models/paginated_scim_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_scim_source_user_list.py
create mode 100644 authentik_client/models/paginated_scope_mapping_list.py
create mode 100644 authentik_client/models/paginated_service_connection_list.py
create mode 100644 authentik_client/models/paginated_sms_device_list.py
create mode 100644 authentik_client/models/paginated_source_list.py
create mode 100644 authentik_client/models/paginated_source_stage_list.py
create mode 100644 authentik_client/models/paginated_ssf_provider_list.py
create mode 100644 authentik_client/models/paginated_ssf_stream_list.py
create mode 100644 authentik_client/models/paginated_stage_list.py
create mode 100644 authentik_client/models/paginated_static_device_list.py
create mode 100644 authentik_client/models/paginated_task_list.py
create mode 100644 authentik_client/models/paginated_telegram_source_list.py
create mode 100644 authentik_client/models/paginated_telegram_source_property_mapping_list.py
create mode 100644 authentik_client/models/paginated_tenant_list.py
create mode 100644 authentik_client/models/paginated_token_list.py
create mode 100644 authentik_client/models/paginated_token_model_list.py
create mode 100644 authentik_client/models/paginated_totp_device_list.py
create mode 100644 authentik_client/models/paginated_unique_password_policy_list.py
create mode 100644 authentik_client/models/paginated_user_consent_list.py
create mode 100644 authentik_client/models/paginated_user_delete_stage_list.py
create mode 100644 authentik_client/models/paginated_user_kerberos_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_ldap_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_list.py
create mode 100644 authentik_client/models/paginated_user_login_stage_list.py
create mode 100644 authentik_client/models/paginated_user_logout_stage_list.py
create mode 100644 authentik_client/models/paginated_user_o_auth_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_plex_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_saml_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_telegram_source_connection_list.py
create mode 100644 authentik_client/models/paginated_user_write_stage_list.py
create mode 100644 authentik_client/models/paginated_web_authn_device_list.py
create mode 100644 authentik_client/models/paginated_web_authn_device_type_list.py
create mode 100644 authentik_client/models/paginated_ws_federation_provider_list.py
create mode 100644 authentik_client/models/pagination.py
create mode 100644 authentik_client/models/partial_group.py
create mode 100644 authentik_client/models/partial_user.py
create mode 100644 authentik_client/models/password_challenge.py
create mode 100644 authentik_client/models/password_challenge_response_request.py
create mode 100644 authentik_client/models/password_expiry_policy.py
create mode 100644 authentik_client/models/password_expiry_policy_request.py
create mode 100644 authentik_client/models/password_policy.py
create mode 100644 authentik_client/models/password_policy_request.py
create mode 100644 authentik_client/models/password_stage.py
create mode 100644 authentik_client/models/password_stage_request.py
create mode 100644 authentik_client/models/patched_account_lockdown_stage_request.py
create mode 100644 authentik_client/models/patched_agent_connector_request.py
create mode 100644 authentik_client/models/patched_apple_independent_secure_enclave_request.py
create mode 100644 authentik_client/models/patched_application_entitlement_request.py
create mode 100644 authentik_client/models/patched_application_request.py
create mode 100644 authentik_client/models/patched_authenticator_duo_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_email_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_endpoint_gdtc_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_sms_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_static_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_totp_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_validate_stage_request.py
create mode 100644 authentik_client/models/patched_authenticator_web_authn_stage_request.py
create mode 100644 authentik_client/models/patched_blueprint_instance_request.py
create mode 100644 authentik_client/models/patched_brand_request.py
create mode 100644 authentik_client/models/patched_captcha_stage_request.py
create mode 100644 authentik_client/models/patched_certificate_key_pair_request.py
create mode 100644 authentik_client/models/patched_connection_token_request.py
create mode 100644 authentik_client/models/patched_consent_stage_request.py
create mode 100644 authentik_client/models/patched_deny_stage_request.py
create mode 100644 authentik_client/models/patched_device_access_group_request.py
create mode 100644 authentik_client/models/patched_device_user_binding_request.py
create mode 100644 authentik_client/models/patched_docker_service_connection_request.py
create mode 100644 authentik_client/models/patched_domain_request.py
create mode 100644 authentik_client/models/patched_dummy_policy_request.py
create mode 100644 authentik_client/models/patched_dummy_stage_request.py
create mode 100644 authentik_client/models/patched_duo_device_request.py
create mode 100644 authentik_client/models/patched_email_device_request.py
create mode 100644 authentik_client/models/patched_email_stage_request.py
create mode 100644 authentik_client/models/patched_endpoint_device_request.py
create mode 100644 authentik_client/models/patched_endpoint_request.py
create mode 100644 authentik_client/models/patched_endpoint_stage_request.py
create mode 100644 authentik_client/models/patched_enrollment_token_request.py
create mode 100644 authentik_client/models/patched_event_matcher_policy_request.py
create mode 100644 authentik_client/models/patched_event_request.py
create mode 100644 authentik_client/models/patched_expression_policy_request.py
create mode 100644 authentik_client/models/patched_fleet_connector_request.py
create mode 100644 authentik_client/models/patched_flow_request.py
create mode 100644 authentik_client/models/patched_flow_stage_binding_request.py
create mode 100644 authentik_client/models/patched_geo_ip_policy_request.py
create mode 100644 authentik_client/models/patched_google_chrome_connector_request.py
create mode 100644 authentik_client/models/patched_google_endpoint_device_request.py
create mode 100644 authentik_client/models/patched_google_workspace_provider_mapping_request.py
create mode 100644 authentik_client/models/patched_google_workspace_provider_request.py
create mode 100644 authentik_client/models/patched_group_kerberos_source_connection_request.py
create mode 100644 authentik_client/models/patched_group_ldap_source_connection_request.py
create mode 100644 authentik_client/models/patched_group_o_auth_source_connection_request.py
create mode 100644 authentik_client/models/patched_group_plex_source_connection_request.py
create mode 100644 authentik_client/models/patched_group_request.py
create mode 100644 authentik_client/models/patched_group_saml_source_connection_request.py
create mode 100644 authentik_client/models/patched_group_source_connection_request.py
create mode 100644 authentik_client/models/patched_group_telegram_source_connection_request.py
create mode 100644 authentik_client/models/patched_identification_stage_request.py
create mode 100644 authentik_client/models/patched_initial_permissions_request.py
create mode 100644 authentik_client/models/patched_invitation_request.py
create mode 100644 authentik_client/models/patched_invitation_stage_request.py
create mode 100644 authentik_client/models/patched_kerberos_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_kerberos_source_request.py
create mode 100644 authentik_client/models/patched_kubernetes_service_connection_request.py
create mode 100644 authentik_client/models/patched_ldap_provider_request.py
create mode 100644 authentik_client/models/patched_ldap_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_ldap_source_request.py
create mode 100644 authentik_client/models/patched_license_request.py
create mode 100644 authentik_client/models/patched_lifecycle_rule_request.py
create mode 100644 authentik_client/models/patched_microsoft_entra_provider_mapping_request.py
create mode 100644 authentik_client/models/patched_microsoft_entra_provider_request.py
create mode 100644 authentik_client/models/patched_mutual_tls_stage_request.py
create mode 100644 authentik_client/models/patched_notification_request.py
create mode 100644 authentik_client/models/patched_notification_rule_request.py
create mode 100644 authentik_client/models/patched_notification_transport_request.py
create mode 100644 authentik_client/models/patched_notification_webhook_mapping_request.py
create mode 100644 authentik_client/models/patched_o_auth2_provider_request.py
create mode 100644 authentik_client/models/patched_o_auth_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_o_auth_source_request.py
create mode 100644 authentik_client/models/patched_outpost_request.py
create mode 100644 authentik_client/models/patched_password_expiry_policy_request.py
create mode 100644 authentik_client/models/patched_password_policy_request.py
create mode 100644 authentik_client/models/patched_password_stage_request.py
create mode 100644 authentik_client/models/patched_permission_assign_request.py
create mode 100644 authentik_client/models/patched_plex_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_plex_source_request.py
create mode 100644 authentik_client/models/patched_policy_binding_request.py
create mode 100644 authentik_client/models/patched_prompt_request.py
create mode 100644 authentik_client/models/patched_prompt_stage_request.py
create mode 100644 authentik_client/models/patched_proxy_provider_request.py
create mode 100644 authentik_client/models/patched_rac_property_mapping_request.py
create mode 100644 authentik_client/models/patched_rac_provider_request.py
create mode 100644 authentik_client/models/patched_radius_provider_property_mapping_request.py
create mode 100644 authentik_client/models/patched_radius_provider_request.py
create mode 100644 authentik_client/models/patched_redirect_stage_request.py
create mode 100644 authentik_client/models/patched_reputation_policy_request.py
create mode 100644 authentik_client/models/patched_role_request.py
create mode 100644 authentik_client/models/patched_saml_property_mapping_request.py
create mode 100644 authentik_client/models/patched_saml_provider_request.py
create mode 100644 authentik_client/models/patched_saml_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_saml_source_request.py
create mode 100644 authentik_client/models/patched_schedule_request.py
create mode 100644 authentik_client/models/patched_scim_mapping_request.py
create mode 100644 authentik_client/models/patched_scim_provider_request.py
create mode 100644 authentik_client/models/patched_scim_source_group_request.py
create mode 100644 authentik_client/models/patched_scim_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_scim_source_request.py
create mode 100644 authentik_client/models/patched_scim_source_user_request.py
create mode 100644 authentik_client/models/patched_scope_mapping_request.py
create mode 100644 authentik_client/models/patched_settings_request.py
create mode 100644 authentik_client/models/patched_settings_request_flags.py
create mode 100644 authentik_client/models/patched_sms_device_request.py
create mode 100644 authentik_client/models/patched_source_stage_request.py
create mode 100644 authentik_client/models/patched_ssf_provider_request.py
create mode 100644 authentik_client/models/patched_static_device_request.py
create mode 100644 authentik_client/models/patched_telegram_source_property_mapping_request.py
create mode 100644 authentik_client/models/patched_telegram_source_request.py
create mode 100644 authentik_client/models/patched_tenant_request.py
create mode 100644 authentik_client/models/patched_token_request.py
create mode 100644 authentik_client/models/patched_totp_device_request.py
create mode 100644 authentik_client/models/patched_unique_password_policy_request.py
create mode 100644 authentik_client/models/patched_user_delete_stage_request.py
create mode 100644 authentik_client/models/patched_user_kerberos_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_ldap_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_login_stage_request.py
create mode 100644 authentik_client/models/patched_user_logout_stage_request.py
create mode 100644 authentik_client/models/patched_user_o_auth_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_plex_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_request.py
create mode 100644 authentik_client/models/patched_user_saml_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_telegram_source_connection_request.py
create mode 100644 authentik_client/models/patched_user_write_stage_request.py
create mode 100644 authentik_client/models/patched_web_authn_device_request.py
create mode 100644 authentik_client/models/patched_ws_federation_provider_request.py
create mode 100644 authentik_client/models/permission.py
create mode 100644 authentik_client/models/permission_assign_request.py
create mode 100644 authentik_client/models/permission_assign_result.py
create mode 100644 authentik_client/models/pkce_method_enum.py
create mode 100644 authentik_client/models/plex_authentication_challenge.py
create mode 100644 authentik_client/models/plex_authentication_challenge_response_request.py
create mode 100644 authentik_client/models/plex_source.py
create mode 100644 authentik_client/models/plex_source_property_mapping.py
create mode 100644 authentik_client/models/plex_source_property_mapping_request.py
create mode 100644 authentik_client/models/plex_source_request.py
create mode 100644 authentik_client/models/plex_token_redeem_request.py
create mode 100644 authentik_client/models/policy.py
create mode 100644 authentik_client/models/policy_binding.py
create mode 100644 authentik_client/models/policy_binding_request.py
create mode 100644 authentik_client/models/policy_engine_mode.py
create mode 100644 authentik_client/models/policy_test_request.py
create mode 100644 authentik_client/models/policy_test_result.py
create mode 100644 authentik_client/models/process.py
create mode 100644 authentik_client/models/process_request.py
create mode 100644 authentik_client/models/prompt.py
create mode 100644 authentik_client/models/prompt_challenge.py
create mode 100644 authentik_client/models/prompt_challenge_response_request.py
create mode 100644 authentik_client/models/prompt_choice.py
create mode 100644 authentik_client/models/prompt_request.py
create mode 100644 authentik_client/models/prompt_stage.py
create mode 100644 authentik_client/models/prompt_stage_request.py
create mode 100644 authentik_client/models/prompt_type_enum.py
create mode 100644 authentik_client/models/property_mapping.py
create mode 100644 authentik_client/models/property_mapping_preview.py
create mode 100644 authentik_client/models/property_mapping_test_request.py
create mode 100644 authentik_client/models/property_mapping_test_result.py
create mode 100644 authentik_client/models/protocol_enum.py
create mode 100644 authentik_client/models/provider.py
create mode 100644 authentik_client/models/provider_enum.py
create mode 100644 authentik_client/models/provider_model_enum.py
create mode 100644 authentik_client/models/provider_type_enum.py
create mode 100644 authentik_client/models/proxy_mode.py
create mode 100644 authentik_client/models/proxy_outpost_config.py
create mode 100644 authentik_client/models/proxy_provider.py
create mode 100644 authentik_client/models/proxy_provider_request.py
create mode 100644 authentik_client/models/rac_property_mapping.py
create mode 100644 authentik_client/models/rac_property_mapping_request.py
create mode 100644 authentik_client/models/rac_provider.py
create mode 100644 authentik_client/models/rac_provider_request.py
create mode 100644 authentik_client/models/radius_check_access.py
create mode 100644 authentik_client/models/radius_outpost_config.py
create mode 100644 authentik_client/models/radius_provider.py
create mode 100644 authentik_client/models/radius_provider_property_mapping.py
create mode 100644 authentik_client/models/radius_provider_property_mapping_request.py
create mode 100644 authentik_client/models/radius_provider_request.py
create mode 100644 authentik_client/models/redirect_challenge.py
create mode 100644 authentik_client/models/redirect_challenge_response_request.py
create mode 100644 authentik_client/models/redirect_stage.py
create mode 100644 authentik_client/models/redirect_stage_mode_enum.py
create mode 100644 authentik_client/models/redirect_stage_request.py
create mode 100644 authentik_client/models/redirect_uri.py
create mode 100644 authentik_client/models/redirect_uri_request.py
create mode 100644 authentik_client/models/redirect_uri_type_enum.py
create mode 100644 authentik_client/models/related_group.py
create mode 100644 authentik_client/models/related_rule.py
create mode 100644 authentik_client/models/reputation.py
create mode 100644 authentik_client/models/reputation_policy.py
create mode 100644 authentik_client/models/reputation_policy_request.py
create mode 100644 authentik_client/models/review.py
create mode 100644 authentik_client/models/review_request.py
create mode 100644 authentik_client/models/reviewer_group.py
create mode 100644 authentik_client/models/reviewer_user.py
create mode 100644 authentik_client/models/role.py
create mode 100644 authentik_client/models/role_assigned_object_permission.py
create mode 100644 authentik_client/models/role_model_permission.py
create mode 100644 authentik_client/models/role_object_permission.py
create mode 100644 authentik_client/models/role_request.py
create mode 100644 authentik_client/models/saml_bindings_enum.py
create mode 100644 authentik_client/models/saml_logout_methods.py
create mode 100644 authentik_client/models/saml_metadata.py
create mode 100644 authentik_client/models/saml_name_id_policy_enum.py
create mode 100644 authentik_client/models/saml_property_mapping.py
create mode 100644 authentik_client/models/saml_property_mapping_request.py
create mode 100644 authentik_client/models/saml_provider.py
create mode 100644 authentik_client/models/saml_provider_request.py
create mode 100644 authentik_client/models/saml_source.py
create mode 100644 authentik_client/models/saml_source_property_mapping.py
create mode 100644 authentik_client/models/saml_source_property_mapping_request.py
create mode 100644 authentik_client/models/saml_source_request.py
create mode 100644 authentik_client/models/schedule.py
create mode 100644 authentik_client/models/schedule_request.py
create mode 100644 authentik_client/models/scim_authentication_mode_enum.py
create mode 100644 authentik_client/models/scim_mapping.py
create mode 100644 authentik_client/models/scim_mapping_request.py
create mode 100644 authentik_client/models/scim_provider.py
create mode 100644 authentik_client/models/scim_provider_group.py
create mode 100644 authentik_client/models/scim_provider_group_request.py
create mode 100644 authentik_client/models/scim_provider_request.py
create mode 100644 authentik_client/models/scim_provider_user.py
create mode 100644 authentik_client/models/scim_provider_user_request.py
create mode 100644 authentik_client/models/scim_source.py
create mode 100644 authentik_client/models/scim_source_group.py
create mode 100644 authentik_client/models/scim_source_group_request.py
create mode 100644 authentik_client/models/scim_source_property_mapping.py
create mode 100644 authentik_client/models/scim_source_property_mapping_request.py
create mode 100644 authentik_client/models/scim_source_request.py
create mode 100644 authentik_client/models/scim_source_user.py
create mode 100644 authentik_client/models/scim_source_user_request.py
create mode 100644 authentik_client/models/scope_mapping.py
create mode 100644 authentik_client/models/scope_mapping_request.py
create mode 100644 authentik_client/models/selectable_stage.py
create mode 100644 authentik_client/models/service_connection.py
create mode 100644 authentik_client/models/service_connection_state.py
create mode 100644 authentik_client/models/session_end_challenge.py
create mode 100644 authentik_client/models/session_user.py
create mode 100644 authentik_client/models/settings.py
create mode 100644 authentik_client/models/settings_request.py
create mode 100644 authentik_client/models/severity_enum.py
create mode 100644 authentik_client/models/shell_challenge.py
create mode 100644 authentik_client/models/signature_algorithm_enum.py
create mode 100644 authentik_client/models/sms_device.py
create mode 100644 authentik_client/models/sms_device_request.py
create mode 100644 authentik_client/models/software.py
create mode 100644 authentik_client/models/software_request.py
create mode 100644 authentik_client/models/source.py
create mode 100644 authentik_client/models/source_stage.py
create mode 100644 authentik_client/models/source_stage_request.py
create mode 100644 authentik_client/models/source_type.py
create mode 100644 authentik_client/models/ssf_provider.py
create mode 100644 authentik_client/models/ssf_provider_request.py
create mode 100644 authentik_client/models/ssf_stream.py
create mode 100644 authentik_client/models/ssf_stream_status_enum.py
create mode 100644 authentik_client/models/stage.py
create mode 100644 authentik_client/models/stage_mode_enum.py
create mode 100644 authentik_client/models/stage_prompt.py
create mode 100644 authentik_client/models/static_device.py
create mode 100644 authentik_client/models/static_device_request.py
create mode 100644 authentik_client/models/static_device_token.py
create mode 100644 authentik_client/models/sub_mode_enum.py
create mode 100644 authentik_client/models/sync_object_model_enum.py
create mode 100644 authentik_client/models/sync_object_request.py
create mode 100644 authentik_client/models/sync_object_result.py
create mode 100644 authentik_client/models/sync_outgoing_trigger_mode_enum.py
create mode 100644 authentik_client/models/sync_status.py
create mode 100644 authentik_client/models/system_info.py
create mode 100644 authentik_client/models/system_info_runtime.py
create mode 100644 authentik_client/models/task.py
create mode 100644 authentik_client/models/task_aggregated_status_enum.py
create mode 100644 authentik_client/models/task_status_enum.py
create mode 100644 authentik_client/models/telegram_auth_request.py
create mode 100644 authentik_client/models/telegram_challenge_response_request.py
create mode 100644 authentik_client/models/telegram_login_challenge.py
create mode 100644 authentik_client/models/telegram_source.py
create mode 100644 authentik_client/models/telegram_source_property_mapping.py
create mode 100644 authentik_client/models/telegram_source_property_mapping_request.py
create mode 100644 authentik_client/models/telegram_source_request.py
create mode 100644 authentik_client/models/tenant.py
create mode 100644 authentik_client/models/tenant_admin_group_request_request.py
create mode 100644 authentik_client/models/tenant_recovery_key_request_request.py
create mode 100644 authentik_client/models/tenant_recovery_key_response.py
create mode 100644 authentik_client/models/tenant_request.py
create mode 100644 authentik_client/models/themed_urls.py
create mode 100644 authentik_client/models/token.py
create mode 100644 authentik_client/models/token_model.py
create mode 100644 authentik_client/models/token_request.py
create mode 100644 authentik_client/models/token_set_key_request.py
create mode 100644 authentik_client/models/token_view.py
create mode 100644 authentik_client/models/totp_device.py
create mode 100644 authentik_client/models/totp_device_request.py
create mode 100644 authentik_client/models/transaction_application_request.py
create mode 100644 authentik_client/models/transaction_application_response.py
create mode 100644 authentik_client/models/transaction_policy_binding_request.py
create mode 100644 authentik_client/models/transport_mode_enum.py
create mode 100644 authentik_client/models/type_create.py
create mode 100644 authentik_client/models/ui_theme_enum.py
create mode 100644 authentik_client/models/unique_password_policy.py
create mode 100644 authentik_client/models/unique_password_policy_request.py
create mode 100644 authentik_client/models/usage_enum.py
create mode 100644 authentik_client/models/used_by.py
create mode 100644 authentik_client/models/used_by_action_enum.py
create mode 100644 authentik_client/models/user.py
create mode 100644 authentik_client/models/user_account_lockdown_request.py
create mode 100644 authentik_client/models/user_account_request.py
create mode 100644 authentik_client/models/user_account_serializer_for_role_request.py
create mode 100644 authentik_client/models/user_attribute_enum.py
create mode 100644 authentik_client/models/user_consent.py
create mode 100644 authentik_client/models/user_creation_mode_enum.py
create mode 100644 authentik_client/models/user_delete_stage.py
create mode 100644 authentik_client/models/user_delete_stage_request.py
create mode 100644 authentik_client/models/user_fields_enum.py
create mode 100644 authentik_client/models/user_kerberos_source_connection.py
create mode 100644 authentik_client/models/user_kerberos_source_connection_request.py
create mode 100644 authentik_client/models/user_ldap_source_connection.py
create mode 100644 authentik_client/models/user_ldap_source_connection_request.py
create mode 100644 authentik_client/models/user_login_challenge.py
create mode 100644 authentik_client/models/user_login_challenge_response_request.py
create mode 100644 authentik_client/models/user_login_stage.py
create mode 100644 authentik_client/models/user_login_stage_request.py
create mode 100644 authentik_client/models/user_logout_stage.py
create mode 100644 authentik_client/models/user_logout_stage_request.py
create mode 100644 authentik_client/models/user_matching_mode_enum.py
create mode 100644 authentik_client/models/user_o_auth_source_connection.py
create mode 100644 authentik_client/models/user_o_auth_source_connection_request.py
create mode 100644 authentik_client/models/user_password_hash_set_request.py
create mode 100644 authentik_client/models/user_password_set_request.py
create mode 100644 authentik_client/models/user_path.py
create mode 100644 authentik_client/models/user_plex_source_connection.py
create mode 100644 authentik_client/models/user_plex_source_connection_request.py
create mode 100644 authentik_client/models/user_recovery_email_request.py
create mode 100644 authentik_client/models/user_recovery_link_request.py
create mode 100644 authentik_client/models/user_request.py
create mode 100644 authentik_client/models/user_saml_source_connection.py
create mode 100644 authentik_client/models/user_saml_source_connection_request.py
create mode 100644 authentik_client/models/user_self.py
create mode 100644 authentik_client/models/user_self_groups.py
create mode 100644 authentik_client/models/user_self_roles.py
create mode 100644 authentik_client/models/user_service_account_request.py
create mode 100644 authentik_client/models/user_service_account_response.py
create mode 100644 authentik_client/models/user_setting.py
create mode 100644 authentik_client/models/user_source_connection.py
create mode 100644 authentik_client/models/user_source_connection_request.py
create mode 100644 authentik_client/models/user_telegram_source_connection.py
create mode 100644 authentik_client/models/user_telegram_source_connection_request.py
create mode 100644 authentik_client/models/user_type_enum.py
create mode 100644 authentik_client/models/user_verification_enum.py
create mode 100644 authentik_client/models/user_write_stage.py
create mode 100644 authentik_client/models/user_write_stage_request.py
create mode 100644 authentik_client/models/validation_error.py
create mode 100644 authentik_client/models/vendor_enum.py
create mode 100644 authentik_client/models/version.py
create mode 100644 authentik_client/models/version_history.py
create mode 100644 authentik_client/models/web_authn_device.py
create mode 100644 authentik_client/models/web_authn_device_request.py
create mode 100644 authentik_client/models/web_authn_device_type.py
create mode 100644 authentik_client/models/web_authn_hint_enum.py
create mode 100644 authentik_client/models/worker.py
create mode 100644 authentik_client/models/ws_federation_provider.py
create mode 100644 authentik_client/models/ws_federation_provider_request.py
create mode 100644 authentik_client/py.typed
create mode 100644 authentik_client/rest.py
create mode 100644 docs/AccessDeniedChallenge.md
create mode 100644 docs/AccountLockdownStage.md
create mode 100644 docs/AccountLockdownStageRequest.md
create mode 100644 docs/AdminApi.md
create mode 100644 docs/AgentAuthenticationResponse.md
create mode 100644 docs/AgentConfig.md
create mode 100644 docs/AgentConnector.md
create mode 100644 docs/AgentConnectorRequest.md
create mode 100644 docs/AgentPSSODeviceRegistrationRequest.md
create mode 100644 docs/AgentPSSODeviceRegistrationResponse.md
create mode 100644 docs/AgentPSSOUserRegistrationRequest.md
create mode 100644 docs/AgentTokenResponse.md
create mode 100644 docs/AlgEnum.md
create mode 100644 docs/App.md
create mode 100644 docs/AppEnum.md
create mode 100644 docs/AppleChallengeResponseRequest.md
create mode 100644 docs/AppleIndependentSecureEnclave.md
create mode 100644 docs/AppleIndependentSecureEnclaveRequest.md
create mode 100644 docs/AppleLoginChallenge.md
create mode 100644 docs/Application.md
create mode 100644 docs/ApplicationEntitlement.md
create mode 100644 docs/ApplicationEntitlementRequest.md
create mode 100644 docs/ApplicationRequest.md
create mode 100644 docs/AuthTypeEnum.md
create mode 100644 docs/AuthenticatedSession.md
create mode 100644 docs/AuthenticatedSessionAsn.md
create mode 100644 docs/AuthenticatedSessionGeoIp.md
create mode 100644 docs/AuthenticatedSessionUserAgent.md
create mode 100644 docs/AuthenticatedSessionUserAgentDevice.md
create mode 100644 docs/AuthenticatedSessionUserAgentOs.md
create mode 100644 docs/AuthenticatedSessionUserAgentUserAgent.md
create mode 100644 docs/AuthenticationEnum.md
create mode 100644 docs/AuthenticatorAttachmentEnum.md
create mode 100644 docs/AuthenticatorDuoChallenge.md
create mode 100644 docs/AuthenticatorDuoChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorDuoStage.md
create mode 100644 docs/AuthenticatorDuoStageDeviceImportResponse.md
create mode 100644 docs/AuthenticatorDuoStageManualDeviceImportRequest.md
create mode 100644 docs/AuthenticatorDuoStageRequest.md
create mode 100644 docs/AuthenticatorEmailChallenge.md
create mode 100644 docs/AuthenticatorEmailChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorEmailStage.md
create mode 100644 docs/AuthenticatorEmailStageRequest.md
create mode 100644 docs/AuthenticatorEndpointGDTCStage.md
create mode 100644 docs/AuthenticatorEndpointGDTCStageRequest.md
create mode 100644 docs/AuthenticatorSMSChallenge.md
create mode 100644 docs/AuthenticatorSMSChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorSMSStage.md
create mode 100644 docs/AuthenticatorSMSStageRequest.md
create mode 100644 docs/AuthenticatorStaticChallenge.md
create mode 100644 docs/AuthenticatorStaticChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorStaticStage.md
create mode 100644 docs/AuthenticatorStaticStageRequest.md
create mode 100644 docs/AuthenticatorTOTPChallenge.md
create mode 100644 docs/AuthenticatorTOTPChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorTOTPStage.md
create mode 100644 docs/AuthenticatorTOTPStageRequest.md
create mode 100644 docs/AuthenticatorValidateStage.md
create mode 100644 docs/AuthenticatorValidateStageRequest.md
create mode 100644 docs/AuthenticatorValidationChallenge.md
create mode 100644 docs/AuthenticatorValidationChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorWebAuthnChallenge.md
create mode 100644 docs/AuthenticatorWebAuthnChallengeResponseRequest.md
create mode 100644 docs/AuthenticatorWebAuthnStage.md
create mode 100644 docs/AuthenticatorWebAuthnStageRequest.md
create mode 100644 docs/AuthenticatorsApi.md
create mode 100644 docs/AuthorizationCodeAuthMethodEnum.md
create mode 100644 docs/AutoSubmitChallengeResponseRequest.md
create mode 100644 docs/AutosubmitChallenge.md
create mode 100644 docs/BackendsEnum.md
create mode 100644 docs/BindingTypeEnum.md
create mode 100644 docs/BlueprintFile.md
create mode 100644 docs/BlueprintImportResult.md
create mode 100644 docs/BlueprintInstance.md
create mode 100644 docs/BlueprintInstanceRequest.md
create mode 100644 docs/BlueprintInstanceStatusEnum.md
create mode 100644 docs/Brand.md
create mode 100644 docs/BrandRequest.md
create mode 100644 docs/BulkDeleteSessionResponse.md
create mode 100644 docs/Cache.md
create mode 100644 docs/CapabilitiesEnum.md
create mode 100644 docs/CaptchaChallenge.md
create mode 100644 docs/CaptchaChallengeResponseRequest.md
create mode 100644 docs/CaptchaStage.md
create mode 100644 docs/CaptchaStageRequest.md
create mode 100644 docs/CertAttributeEnum.md
create mode 100644 docs/CertificateData.md
create mode 100644 docs/CertificateGenerationRequest.md
create mode 100644 docs/CertificateKeyPair.md
create mode 100644 docs/CertificateKeyPairKeyTypeEnum.md
create mode 100644 docs/CertificateKeyPairRequest.md
create mode 100644 docs/ChallengeTypes.md
create mode 100644 docs/ClientTypeEnum.md
create mode 100644 docs/CompatibilityModeEnum.md
create mode 100644 docs/Config.md
create mode 100644 docs/ConnectionToken.md
create mode 100644 docs/ConnectionTokenRequest.md
create mode 100644 docs/Connector.md
create mode 100644 docs/ConsentChallenge.md
create mode 100644 docs/ConsentChallengeResponseRequest.md
create mode 100644 docs/ConsentModeEnum.md
create mode 100644 docs/ConsentPermission.md
create mode 100644 docs/ConsentStage.md
create mode 100644 docs/ConsentStageRequest.md
create mode 100644 docs/ContentType.md
create mode 100644 docs/ContentTypeEnum.md
create mode 100644 docs/ContextualFlowInfo.md
create mode 100644 docs/ContextualFlowInfoLayoutEnum.md
create mode 100644 docs/CoreApi.md
create mode 100644 docs/CountryCodeEnum.md
create mode 100644 docs/CryptoApi.md
create mode 100644 docs/CurrentBrand.md
create mode 100644 docs/CurrentBrandFlags.md
create mode 100644 docs/DataExport.md
create mode 100644 docs/DeliveryMethodEnum.md
create mode 100644 docs/DeniedActionEnum.md
create mode 100644 docs/DenyStage.md
create mode 100644 docs/DenyStageRequest.md
create mode 100644 docs/DetailedCountry.md
create mode 100644 docs/Device.md
create mode 100644 docs/DeviceAccessGroup.md
create mode 100644 docs/DeviceAccessGroupRequest.md
create mode 100644 docs/DeviceChallenge.md
create mode 100644 docs/DeviceChallengeRequest.md
create mode 100644 docs/DeviceClassesEnum.md
create mode 100644 docs/DeviceConnection.md
create mode 100644 docs/DeviceFactSnapshot.md
create mode 100644 docs/DeviceFacts.md
create mode 100644 docs/DeviceFactsOSFamily.md
create mode 100644 docs/DeviceFactsRequest.md
create mode 100644 docs/DeviceGroup.md
create mode 100644 docs/DeviceGroupRequest.md
create mode 100644 docs/DeviceSummary.md
create mode 100644 docs/DeviceUser.md
create mode 100644 docs/DeviceUserBinding.md
create mode 100644 docs/DeviceUserBindingRequest.md
create mode 100644 docs/DeviceUserRequest.md
create mode 100644 docs/DigestAlgorithmEnum.md
create mode 100644 docs/DigitsEnum.md
create mode 100644 docs/Disk.md
create mode 100644 docs/DiskRequest.md
create mode 100644 docs/DockerServiceConnection.md
create mode 100644 docs/DockerServiceConnectionRequest.md
create mode 100644 docs/Domain.md
create mode 100644 docs/DomainRequest.md
create mode 100644 docs/DummyChallenge.md
create mode 100644 docs/DummyChallengeResponseRequest.md
create mode 100644 docs/DummyPolicy.md
create mode 100644 docs/DummyPolicyRequest.md
create mode 100644 docs/DummyStage.md
create mode 100644 docs/DummyStageRequest.md
create mode 100644 docs/DuoDevice.md
create mode 100644 docs/DuoDeviceEnrollmentStatus.md
create mode 100644 docs/DuoDeviceRequest.md
create mode 100644 docs/DuoResponseEnum.md
create mode 100644 docs/EmailChallenge.md
create mode 100644 docs/EmailChallengeResponseRequest.md
create mode 100644 docs/EmailDevice.md
create mode 100644 docs/EmailDeviceRequest.md
create mode 100644 docs/EmailStage.md
create mode 100644 docs/EmailStageRequest.md
create mode 100644 docs/Endpoint.md
create mode 100644 docs/EndpointAgentChallenge.md
create mode 100644 docs/EndpointAgentChallengeResponseRequest.md
create mode 100644 docs/EndpointAuthModeEnum.md
create mode 100644 docs/EndpointDevice.md
create mode 100644 docs/EndpointDeviceDetails.md
create mode 100644 docs/EndpointDeviceRequest.md
create mode 100644 docs/EndpointRequest.md
create mode 100644 docs/EndpointStage.md
create mode 100644 docs/EndpointStageRequest.md
create mode 100644 docs/EndpointsApi.md
create mode 100644 docs/EnrollRequest.md
create mode 100644 docs/EnrollmentToken.md
create mode 100644 docs/EnrollmentTokenRequest.md
create mode 100644 docs/EnterpriseApi.md
create mode 100644 docs/ErrorDetail.md
create mode 100644 docs/ErrorReportingConfig.md
create mode 100644 docs/Event.md
create mode 100644 docs/EventActions.md
create mode 100644 docs/EventMatcherPolicy.md
create mode 100644 docs/EventMatcherPolicyRequest.md
create mode 100644 docs/EventRequest.md
create mode 100644 docs/EventStats.md
create mode 100644 docs/EventTopPerUser.md
create mode 100644 docs/EventVolume.md
create mode 100644 docs/EventsApi.md
create mode 100644 docs/EventsRequestedEnum.md
create mode 100644 docs/ExpiringBaseGrantModel.md
create mode 100644 docs/ExpressionPolicy.md
create mode 100644 docs/ExpressionPolicyRequest.md
create mode 100644 docs/ExtraRoleObjectPermission.md
create mode 100644 docs/FileList.md
create mode 100644 docs/FleetConnector.md
create mode 100644 docs/FleetConnectorRequest.md
create mode 100644 docs/Flow.md
create mode 100644 docs/FlowChallengeResponseRequest.md
create mode 100644 docs/FlowDesignationEnum.md
create mode 100644 docs/FlowDiagram.md
create mode 100644 docs/FlowErrorChallenge.md
create mode 100644 docs/FlowInspection.md
create mode 100644 docs/FlowInspectorPlan.md
create mode 100644 docs/FlowLayoutEnum.md
create mode 100644 docs/FlowRequest.md
create mode 100644 docs/FlowSet.md
create mode 100644 docs/FlowStageBinding.md
create mode 100644 docs/FlowStageBindingRequest.md
create mode 100644 docs/FlowsApi.md
create mode 100644 docs/FooterLink.md
create mode 100644 docs/ForceBindingEnum.md
create mode 100644 docs/FormatEnum.md
create mode 100644 docs/FrameChallenge.md
create mode 100644 docs/FrameChallengeResponseRequest.md
create mode 100644 docs/GenericError.md
create mode 100644 docs/GeoIPPolicy.md
create mode 100644 docs/GeoIPPolicyCountriesObjInner.md
create mode 100644 docs/GeoIPPolicyRequest.md
create mode 100644 docs/GeoipBindingEnum.md
create mode 100644 docs/GlobalTaskStatus.md
create mode 100644 docs/GoogleChromeConnector.md
create mode 100644 docs/GoogleChromeConnectorRequest.md
create mode 100644 docs/GoogleEndpointDevice.md
create mode 100644 docs/GoogleEndpointDeviceRequest.md
create mode 100644 docs/GoogleWorkspaceProvider.md
create mode 100644 docs/GoogleWorkspaceProviderGroup.md
create mode 100644 docs/GoogleWorkspaceProviderGroupRequest.md
create mode 100644 docs/GoogleWorkspaceProviderMapping.md
create mode 100644 docs/GoogleWorkspaceProviderMappingRequest.md
create mode 100644 docs/GoogleWorkspaceProviderRequest.md
create mode 100644 docs/GoogleWorkspaceProviderUser.md
create mode 100644 docs/GoogleWorkspaceProviderUserRequest.md
create mode 100644 docs/GrantTypesEnum.md
create mode 100644 docs/Group.md
create mode 100644 docs/GroupKerberosSourceConnection.md
create mode 100644 docs/GroupKerberosSourceConnectionRequest.md
create mode 100644 docs/GroupLDAPSourceConnection.md
create mode 100644 docs/GroupLDAPSourceConnectionRequest.md
create mode 100644 docs/GroupMatchingModeEnum.md
create mode 100644 docs/GroupOAuthSourceConnection.md
create mode 100644 docs/GroupOAuthSourceConnectionRequest.md
create mode 100644 docs/GroupPlexSourceConnection.md
create mode 100644 docs/GroupPlexSourceConnectionRequest.md
create mode 100644 docs/GroupRequest.md
create mode 100644 docs/GroupSAMLSourceConnection.md
create mode 100644 docs/GroupSAMLSourceConnectionRequest.md
create mode 100644 docs/GroupSourceConnection.md
create mode 100644 docs/GroupSourceConnectionRequest.md
create mode 100644 docs/GroupTelegramSourceConnection.md
create mode 100644 docs/GroupTelegramSourceConnectionRequest.md
create mode 100644 docs/Hardware.md
create mode 100644 docs/HardwareRequest.md
create mode 100644 docs/IdentificationChallenge.md
create mode 100644 docs/IdentificationChallengeResponseRequest.md
create mode 100644 docs/IdentificationStage.md
create mode 100644 docs/IdentificationStageRequest.md
create mode 100644 docs/IframeLogoutChallenge.md
create mode 100644 docs/IframeLogoutChallengeResponseRequest.md
create mode 100644 docs/ImpersonationRequest.md
create mode 100644 docs/InitialPermissions.md
create mode 100644 docs/InitialPermissionsRequest.md
create mode 100644 docs/InstallID.md
create mode 100644 docs/IntentEnum.md
create mode 100644 docs/InvalidResponseActionEnum.md
create mode 100644 docs/Invitation.md
create mode 100644 docs/InvitationRequest.md
create mode 100644 docs/InvitationSendEmailRequest.md
create mode 100644 docs/InvitationStage.md
create mode 100644 docs/InvitationStageRequest.md
create mode 100644 docs/IssuerModeEnum.md
create mode 100644 docs/KadminTypeEnum.md
create mode 100644 docs/KerberosSource.md
create mode 100644 docs/KerberosSourcePropertyMapping.md
create mode 100644 docs/KerberosSourcePropertyMappingRequest.md
create mode 100644 docs/KerberosSourceRequest.md
create mode 100644 docs/KeyTypeEnum.md
create mode 100644 docs/KubernetesServiceConnection.md
create mode 100644 docs/KubernetesServiceConnectionRequest.md
create mode 100644 docs/LDAPAPIAccessMode.md
create mode 100644 docs/LDAPCheckAccess.md
create mode 100644 docs/LDAPDebug.md
create mode 100644 docs/LDAPOutpostConfig.md
create mode 100644 docs/LDAPProvider.md
create mode 100644 docs/LDAPProviderRequest.md
create mode 100644 docs/LDAPSource.md
create mode 100644 docs/LDAPSourcePropertyMapping.md
create mode 100644 docs/LDAPSourcePropertyMappingRequest.md
create mode 100644 docs/LDAPSourceRequest.md
create mode 100644 docs/LangEnum.md
create mode 100644 docs/LastTaskStatusEnum.md
create mode 100644 docs/License.md
create mode 100644 docs/LicenseFlagsEnum.md
create mode 100644 docs/LicenseForecast.md
create mode 100644 docs/LicenseRequest.md
create mode 100644 docs/LicenseStatusEnum.md
create mode 100644 docs/LicenseSummary.md
create mode 100644 docs/LicenseSummaryStatusEnum.md
create mode 100644 docs/LifecycleApi.md
create mode 100644 docs/LifecycleIteration.md
create mode 100644 docs/LifecycleIterationRequest.md
create mode 100644 docs/LifecycleIterationStateEnum.md
create mode 100644 docs/LifecycleRule.md
create mode 100644 docs/LifecycleRuleRequest.md
create mode 100644 docs/Link.md
create mode 100644 docs/LogEvent.md
create mode 100644 docs/LogLevelEnum.md
create mode 100644 docs/LoginChallengeTypes.md
create mode 100644 docs/LoginSource.md
create mode 100644 docs/LogoutURL.md
create mode 100644 docs/MDMConfigRequest.md
create mode 100644 docs/MDMConfigResponse.md
create mode 100644 docs/ManagedApi.md
create mode 100644 docs/MatchingModeEnum.md
create mode 100644 docs/Metadata.md
create mode 100644 docs/MicrosoftEntraProvider.md
create mode 100644 docs/MicrosoftEntraProviderGroup.md
create mode 100644 docs/MicrosoftEntraProviderGroupRequest.md
create mode 100644 docs/MicrosoftEntraProviderMapping.md
create mode 100644 docs/MicrosoftEntraProviderMappingRequest.md
create mode 100644 docs/MicrosoftEntraProviderRequest.md
create mode 100644 docs/MicrosoftEntraProviderUser.md
create mode 100644 docs/MicrosoftEntraProviderUserRequest.md
create mode 100644 docs/ModelEnum.md
create mode 100644 docs/ModelRequest.md
create mode 100644 docs/MutualTLSStage.md
create mode 100644 docs/MutualTLSStageRequest.md
create mode 100644 docs/NativeLogoutChallenge.md
create mode 100644 docs/NativeLogoutChallengeResponseRequest.md
create mode 100644 docs/Network.md
create mode 100644 docs/NetworkBindingEnum.md
create mode 100644 docs/NetworkInterface.md
create mode 100644 docs/NetworkInterfaceRequest.md
create mode 100644 docs/NetworkRequest.md
create mode 100644 docs/NotConfiguredActionEnum.md
create mode 100644 docs/Notification.md
create mode 100644 docs/NotificationRequest.md
create mode 100644 docs/NotificationRule.md
create mode 100644 docs/NotificationRuleRequest.md
create mode 100644 docs/NotificationTransport.md
create mode 100644 docs/NotificationTransportRequest.md
create mode 100644 docs/NotificationTransportTest.md
create mode 100644 docs/NotificationWebhookMapping.md
create mode 100644 docs/NotificationWebhookMappingRequest.md
create mode 100644 docs/OAuth2Provider.md
create mode 100644 docs/OAuth2ProviderLogoutMethodEnum.md
create mode 100644 docs/OAuth2ProviderRequest.md
create mode 100644 docs/OAuth2ProviderSetupURLs.md
create mode 100644 docs/OAuthDeviceCodeChallenge.md
create mode 100644 docs/OAuthDeviceCodeChallengeResponseRequest.md
create mode 100644 docs/OAuthDeviceCodeFinishChallenge.md
create mode 100644 docs/OAuthDeviceCodeFinishChallengeResponseRequest.md
create mode 100644 docs/OAuthSource.md
create mode 100644 docs/OAuthSourcePropertyMapping.md
create mode 100644 docs/OAuthSourcePropertyMappingRequest.md
create mode 100644 docs/OAuthSourceRequest.md
create mode 100644 docs/Oauth2Api.md
create mode 100644 docs/OpenIDConnectConfiguration.md
create mode 100644 docs/OperatingSystem.md
create mode 100644 docs/OperatingSystemRequest.md
create mode 100644 docs/OutgoingSyncDeleteAction.md
create mode 100644 docs/Outpost.md
create mode 100644 docs/OutpostDefaultConfig.md
create mode 100644 docs/OutpostHealth.md
create mode 100644 docs/OutpostRequest.md
create mode 100644 docs/OutpostTypeEnum.md
create mode 100644 docs/OutpostsApi.md
create mode 100644 docs/PKCEMethodEnum.md
create mode 100644 docs/PaginatedAccountLockdownStageList.md
create mode 100644 docs/PaginatedAgentConnectorList.md
create mode 100644 docs/PaginatedAppleIndependentSecureEnclaveList.md
create mode 100644 docs/PaginatedApplicationEntitlementList.md
create mode 100644 docs/PaginatedApplicationList.md
create mode 100644 docs/PaginatedAuthenticatedSessionList.md
create mode 100644 docs/PaginatedAuthenticatorDuoStageList.md
create mode 100644 docs/PaginatedAuthenticatorEmailStageList.md
create mode 100644 docs/PaginatedAuthenticatorEndpointGDTCStageList.md
create mode 100644 docs/PaginatedAuthenticatorSMSStageList.md
create mode 100644 docs/PaginatedAuthenticatorStaticStageList.md
create mode 100644 docs/PaginatedAuthenticatorTOTPStageList.md
create mode 100644 docs/PaginatedAuthenticatorValidateStageList.md
create mode 100644 docs/PaginatedAuthenticatorWebAuthnStageList.md
create mode 100644 docs/PaginatedBlueprintInstanceList.md
create mode 100644 docs/PaginatedBrandList.md
create mode 100644 docs/PaginatedCaptchaStageList.md
create mode 100644 docs/PaginatedCertificateKeyPairList.md
create mode 100644 docs/PaginatedConnectionTokenList.md
create mode 100644 docs/PaginatedConnectorList.md
create mode 100644 docs/PaginatedConsentStageList.md
create mode 100644 docs/PaginatedDataExportList.md
create mode 100644 docs/PaginatedDenyStageList.md
create mode 100644 docs/PaginatedDeviceAccessGroupList.md
create mode 100644 docs/PaginatedDeviceUserBindingList.md
create mode 100644 docs/PaginatedDockerServiceConnectionList.md
create mode 100644 docs/PaginatedDomainList.md
create mode 100644 docs/PaginatedDummyPolicyList.md
create mode 100644 docs/PaginatedDummyStageList.md
create mode 100644 docs/PaginatedDuoDeviceList.md
create mode 100644 docs/PaginatedEmailDeviceList.md
create mode 100644 docs/PaginatedEmailStageList.md
create mode 100644 docs/PaginatedEndpointDeviceList.md
create mode 100644 docs/PaginatedEndpointList.md
create mode 100644 docs/PaginatedEndpointStageList.md
create mode 100644 docs/PaginatedEnrollmentTokenList.md
create mode 100644 docs/PaginatedEventList.md
create mode 100644 docs/PaginatedEventMatcherPolicyList.md
create mode 100644 docs/PaginatedExpiringBaseGrantModelList.md
create mode 100644 docs/PaginatedExpressionPolicyList.md
create mode 100644 docs/PaginatedExtraRoleObjectPermissionList.md
create mode 100644 docs/PaginatedFleetConnectorList.md
create mode 100644 docs/PaginatedFlowList.md
create mode 100644 docs/PaginatedFlowStageBindingList.md
create mode 100644 docs/PaginatedGeoIPPolicyList.md
create mode 100644 docs/PaginatedGoogleChromeConnectorList.md
create mode 100644 docs/PaginatedGoogleEndpointDeviceList.md
create mode 100644 docs/PaginatedGoogleWorkspaceProviderGroupList.md
create mode 100644 docs/PaginatedGoogleWorkspaceProviderList.md
create mode 100644 docs/PaginatedGoogleWorkspaceProviderMappingList.md
create mode 100644 docs/PaginatedGoogleWorkspaceProviderUserList.md
create mode 100644 docs/PaginatedGroupKerberosSourceConnectionList.md
create mode 100644 docs/PaginatedGroupLDAPSourceConnectionList.md
create mode 100644 docs/PaginatedGroupList.md
create mode 100644 docs/PaginatedGroupOAuthSourceConnectionList.md
create mode 100644 docs/PaginatedGroupPlexSourceConnectionList.md
create mode 100644 docs/PaginatedGroupSAMLSourceConnectionList.md
create mode 100644 docs/PaginatedGroupSourceConnectionList.md
create mode 100644 docs/PaginatedGroupTelegramSourceConnectionList.md
create mode 100644 docs/PaginatedIdentificationStageList.md
create mode 100644 docs/PaginatedInitialPermissionsList.md
create mode 100644 docs/PaginatedInvitationList.md
create mode 100644 docs/PaginatedInvitationStageList.md
create mode 100644 docs/PaginatedKerberosSourceList.md
create mode 100644 docs/PaginatedKerberosSourcePropertyMappingList.md
create mode 100644 docs/PaginatedKubernetesServiceConnectionList.md
create mode 100644 docs/PaginatedLDAPOutpostConfigList.md
create mode 100644 docs/PaginatedLDAPProviderList.md
create mode 100644 docs/PaginatedLDAPSourceList.md
create mode 100644 docs/PaginatedLDAPSourcePropertyMappingList.md
create mode 100644 docs/PaginatedLicenseList.md
create mode 100644 docs/PaginatedLifecycleIterationList.md
create mode 100644 docs/PaginatedLifecycleRuleList.md
create mode 100644 docs/PaginatedMicrosoftEntraProviderGroupList.md
create mode 100644 docs/PaginatedMicrosoftEntraProviderList.md
create mode 100644 docs/PaginatedMicrosoftEntraProviderMappingList.md
create mode 100644 docs/PaginatedMicrosoftEntraProviderUserList.md
create mode 100644 docs/PaginatedMutualTLSStageList.md
create mode 100644 docs/PaginatedNotificationList.md
create mode 100644 docs/PaginatedNotificationRuleList.md
create mode 100644 docs/PaginatedNotificationTransportList.md
create mode 100644 docs/PaginatedNotificationWebhookMappingList.md
create mode 100644 docs/PaginatedOAuth2ProviderList.md
create mode 100644 docs/PaginatedOAuthSourceList.md
create mode 100644 docs/PaginatedOAuthSourcePropertyMappingList.md
create mode 100644 docs/PaginatedOutpostList.md
create mode 100644 docs/PaginatedPasswordExpiryPolicyList.md
create mode 100644 docs/PaginatedPasswordPolicyList.md
create mode 100644 docs/PaginatedPasswordStageList.md
create mode 100644 docs/PaginatedPermissionList.md
create mode 100644 docs/PaginatedPlexSourceList.md
create mode 100644 docs/PaginatedPlexSourcePropertyMappingList.md
create mode 100644 docs/PaginatedPolicyBindingList.md
create mode 100644 docs/PaginatedPolicyList.md
create mode 100644 docs/PaginatedPromptList.md
create mode 100644 docs/PaginatedPromptStageList.md
create mode 100644 docs/PaginatedPropertyMappingList.md
create mode 100644 docs/PaginatedProviderList.md
create mode 100644 docs/PaginatedProxyOutpostConfigList.md
create mode 100644 docs/PaginatedProxyProviderList.md
create mode 100644 docs/PaginatedRACPropertyMappingList.md
create mode 100644 docs/PaginatedRACProviderList.md
create mode 100644 docs/PaginatedRadiusOutpostConfigList.md
create mode 100644 docs/PaginatedRadiusProviderList.md
create mode 100644 docs/PaginatedRadiusProviderPropertyMappingList.md
create mode 100644 docs/PaginatedRedirectStageList.md
create mode 100644 docs/PaginatedReputationList.md
create mode 100644 docs/PaginatedReputationPolicyList.md
create mode 100644 docs/PaginatedRoleAssignedObjectPermissionList.md
create mode 100644 docs/PaginatedRoleList.md
create mode 100644 docs/PaginatedSAMLPropertyMappingList.md
create mode 100644 docs/PaginatedSAMLProviderList.md
create mode 100644 docs/PaginatedSAMLSourceList.md
create mode 100644 docs/PaginatedSAMLSourcePropertyMappingList.md
create mode 100644 docs/PaginatedSCIMMappingList.md
create mode 100644 docs/PaginatedSCIMProviderGroupList.md
create mode 100644 docs/PaginatedSCIMProviderList.md
create mode 100644 docs/PaginatedSCIMProviderUserList.md
create mode 100644 docs/PaginatedSCIMSourceGroupList.md
create mode 100644 docs/PaginatedSCIMSourceList.md
create mode 100644 docs/PaginatedSCIMSourcePropertyMappingList.md
create mode 100644 docs/PaginatedSCIMSourceUserList.md
create mode 100644 docs/PaginatedSMSDeviceList.md
create mode 100644 docs/PaginatedSSFProviderList.md
create mode 100644 docs/PaginatedSSFStreamList.md
create mode 100644 docs/PaginatedScheduleList.md
create mode 100644 docs/PaginatedScopeMappingList.md
create mode 100644 docs/PaginatedServiceConnectionList.md
create mode 100644 docs/PaginatedSourceList.md
create mode 100644 docs/PaginatedSourceStageList.md
create mode 100644 docs/PaginatedStageList.md
create mode 100644 docs/PaginatedStaticDeviceList.md
create mode 100644 docs/PaginatedTOTPDeviceList.md
create mode 100644 docs/PaginatedTaskList.md
create mode 100644 docs/PaginatedTelegramSourceList.md
create mode 100644 docs/PaginatedTelegramSourcePropertyMappingList.md
create mode 100644 docs/PaginatedTenantList.md
create mode 100644 docs/PaginatedTokenList.md
create mode 100644 docs/PaginatedTokenModelList.md
create mode 100644 docs/PaginatedUniquePasswordPolicyList.md
create mode 100644 docs/PaginatedUserConsentList.md
create mode 100644 docs/PaginatedUserDeleteStageList.md
create mode 100644 docs/PaginatedUserKerberosSourceConnectionList.md
create mode 100644 docs/PaginatedUserLDAPSourceConnectionList.md
create mode 100644 docs/PaginatedUserList.md
create mode 100644 docs/PaginatedUserLoginStageList.md
create mode 100644 docs/PaginatedUserLogoutStageList.md
create mode 100644 docs/PaginatedUserOAuthSourceConnectionList.md
create mode 100644 docs/PaginatedUserPlexSourceConnectionList.md
create mode 100644 docs/PaginatedUserSAMLSourceConnectionList.md
create mode 100644 docs/PaginatedUserSourceConnectionList.md
create mode 100644 docs/PaginatedUserTelegramSourceConnectionList.md
create mode 100644 docs/PaginatedUserWriteStageList.md
create mode 100644 docs/PaginatedWSFederationProviderList.md
create mode 100644 docs/PaginatedWebAuthnDeviceList.md
create mode 100644 docs/PaginatedWebAuthnDeviceTypeList.md
create mode 100644 docs/Pagination.md
create mode 100644 docs/PartialGroup.md
create mode 100644 docs/PartialUser.md
create mode 100644 docs/PasswordChallenge.md
create mode 100644 docs/PasswordChallengeResponseRequest.md
create mode 100644 docs/PasswordExpiryPolicy.md
create mode 100644 docs/PasswordExpiryPolicyRequest.md
create mode 100644 docs/PasswordPolicy.md
create mode 100644 docs/PasswordPolicyRequest.md
create mode 100644 docs/PasswordStage.md
create mode 100644 docs/PasswordStageRequest.md
create mode 100644 docs/PatchedAccountLockdownStageRequest.md
create mode 100644 docs/PatchedAgentConnectorRequest.md
create mode 100644 docs/PatchedAppleIndependentSecureEnclaveRequest.md
create mode 100644 docs/PatchedApplicationEntitlementRequest.md
create mode 100644 docs/PatchedApplicationRequest.md
create mode 100644 docs/PatchedAuthenticatorDuoStageRequest.md
create mode 100644 docs/PatchedAuthenticatorEmailStageRequest.md
create mode 100644 docs/PatchedAuthenticatorEndpointGDTCStageRequest.md
create mode 100644 docs/PatchedAuthenticatorSMSStageRequest.md
create mode 100644 docs/PatchedAuthenticatorStaticStageRequest.md
create mode 100644 docs/PatchedAuthenticatorTOTPStageRequest.md
create mode 100644 docs/PatchedAuthenticatorValidateStageRequest.md
create mode 100644 docs/PatchedAuthenticatorWebAuthnStageRequest.md
create mode 100644 docs/PatchedBlueprintInstanceRequest.md
create mode 100644 docs/PatchedBrandRequest.md
create mode 100644 docs/PatchedCaptchaStageRequest.md
create mode 100644 docs/PatchedCertificateKeyPairRequest.md
create mode 100644 docs/PatchedConnectionTokenRequest.md
create mode 100644 docs/PatchedConsentStageRequest.md
create mode 100644 docs/PatchedDenyStageRequest.md
create mode 100644 docs/PatchedDeviceAccessGroupRequest.md
create mode 100644 docs/PatchedDeviceUserBindingRequest.md
create mode 100644 docs/PatchedDockerServiceConnectionRequest.md
create mode 100644 docs/PatchedDomainRequest.md
create mode 100644 docs/PatchedDummyPolicyRequest.md
create mode 100644 docs/PatchedDummyStageRequest.md
create mode 100644 docs/PatchedDuoDeviceRequest.md
create mode 100644 docs/PatchedEmailDeviceRequest.md
create mode 100644 docs/PatchedEmailStageRequest.md
create mode 100644 docs/PatchedEndpointDeviceRequest.md
create mode 100644 docs/PatchedEndpointRequest.md
create mode 100644 docs/PatchedEndpointStageRequest.md
create mode 100644 docs/PatchedEnrollmentTokenRequest.md
create mode 100644 docs/PatchedEventMatcherPolicyRequest.md
create mode 100644 docs/PatchedEventRequest.md
create mode 100644 docs/PatchedExpressionPolicyRequest.md
create mode 100644 docs/PatchedFleetConnectorRequest.md
create mode 100644 docs/PatchedFlowRequest.md
create mode 100644 docs/PatchedFlowStageBindingRequest.md
create mode 100644 docs/PatchedGeoIPPolicyRequest.md
create mode 100644 docs/PatchedGoogleChromeConnectorRequest.md
create mode 100644 docs/PatchedGoogleEndpointDeviceRequest.md
create mode 100644 docs/PatchedGoogleWorkspaceProviderMappingRequest.md
create mode 100644 docs/PatchedGoogleWorkspaceProviderRequest.md
create mode 100644 docs/PatchedGroupKerberosSourceConnectionRequest.md
create mode 100644 docs/PatchedGroupLDAPSourceConnectionRequest.md
create mode 100644 docs/PatchedGroupOAuthSourceConnectionRequest.md
create mode 100644 docs/PatchedGroupPlexSourceConnectionRequest.md
create mode 100644 docs/PatchedGroupRequest.md
create mode 100644 docs/PatchedGroupSAMLSourceConnectionRequest.md
create mode 100644 docs/PatchedGroupSourceConnectionRequest.md
create mode 100644 docs/PatchedGroupTelegramSourceConnectionRequest.md
create mode 100644 docs/PatchedIdentificationStageRequest.md
create mode 100644 docs/PatchedInitialPermissionsRequest.md
create mode 100644 docs/PatchedInvitationRequest.md
create mode 100644 docs/PatchedInvitationStageRequest.md
create mode 100644 docs/PatchedKerberosSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedKerberosSourceRequest.md
create mode 100644 docs/PatchedKubernetesServiceConnectionRequest.md
create mode 100644 docs/PatchedLDAPProviderRequest.md
create mode 100644 docs/PatchedLDAPSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedLDAPSourceRequest.md
create mode 100644 docs/PatchedLicenseRequest.md
create mode 100644 docs/PatchedLifecycleRuleRequest.md
create mode 100644 docs/PatchedMicrosoftEntraProviderMappingRequest.md
create mode 100644 docs/PatchedMicrosoftEntraProviderRequest.md
create mode 100644 docs/PatchedMutualTLSStageRequest.md
create mode 100644 docs/PatchedNotificationRequest.md
create mode 100644 docs/PatchedNotificationRuleRequest.md
create mode 100644 docs/PatchedNotificationTransportRequest.md
create mode 100644 docs/PatchedNotificationWebhookMappingRequest.md
create mode 100644 docs/PatchedOAuth2ProviderRequest.md
create mode 100644 docs/PatchedOAuthSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedOAuthSourceRequest.md
create mode 100644 docs/PatchedOutpostRequest.md
create mode 100644 docs/PatchedPasswordExpiryPolicyRequest.md
create mode 100644 docs/PatchedPasswordPolicyRequest.md
create mode 100644 docs/PatchedPasswordStageRequest.md
create mode 100644 docs/PatchedPermissionAssignRequest.md
create mode 100644 docs/PatchedPlexSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedPlexSourceRequest.md
create mode 100644 docs/PatchedPolicyBindingRequest.md
create mode 100644 docs/PatchedPromptRequest.md
create mode 100644 docs/PatchedPromptStageRequest.md
create mode 100644 docs/PatchedProxyProviderRequest.md
create mode 100644 docs/PatchedRACPropertyMappingRequest.md
create mode 100644 docs/PatchedRACProviderRequest.md
create mode 100644 docs/PatchedRadiusProviderPropertyMappingRequest.md
create mode 100644 docs/PatchedRadiusProviderRequest.md
create mode 100644 docs/PatchedRedirectStageRequest.md
create mode 100644 docs/PatchedReputationPolicyRequest.md
create mode 100644 docs/PatchedRoleRequest.md
create mode 100644 docs/PatchedSAMLPropertyMappingRequest.md
create mode 100644 docs/PatchedSAMLProviderRequest.md
create mode 100644 docs/PatchedSAMLSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedSAMLSourceRequest.md
create mode 100644 docs/PatchedSCIMMappingRequest.md
create mode 100644 docs/PatchedSCIMProviderRequest.md
create mode 100644 docs/PatchedSCIMSourceGroupRequest.md
create mode 100644 docs/PatchedSCIMSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedSCIMSourceRequest.md
create mode 100644 docs/PatchedSCIMSourceUserRequest.md
create mode 100644 docs/PatchedSMSDeviceRequest.md
create mode 100644 docs/PatchedSSFProviderRequest.md
create mode 100644 docs/PatchedScheduleRequest.md
create mode 100644 docs/PatchedScopeMappingRequest.md
create mode 100644 docs/PatchedSettingsRequest.md
create mode 100644 docs/PatchedSettingsRequestFlags.md
create mode 100644 docs/PatchedSourceStageRequest.md
create mode 100644 docs/PatchedStaticDeviceRequest.md
create mode 100644 docs/PatchedTOTPDeviceRequest.md
create mode 100644 docs/PatchedTelegramSourcePropertyMappingRequest.md
create mode 100644 docs/PatchedTelegramSourceRequest.md
create mode 100644 docs/PatchedTenantRequest.md
create mode 100644 docs/PatchedTokenRequest.md
create mode 100644 docs/PatchedUniquePasswordPolicyRequest.md
create mode 100644 docs/PatchedUserDeleteStageRequest.md
create mode 100644 docs/PatchedUserKerberosSourceConnectionRequest.md
create mode 100644 docs/PatchedUserLDAPSourceConnectionRequest.md
create mode 100644 docs/PatchedUserLoginStageRequest.md
create mode 100644 docs/PatchedUserLogoutStageRequest.md
create mode 100644 docs/PatchedUserOAuthSourceConnectionRequest.md
create mode 100644 docs/PatchedUserPlexSourceConnectionRequest.md
create mode 100644 docs/PatchedUserRequest.md
create mode 100644 docs/PatchedUserSAMLSourceConnectionRequest.md
create mode 100644 docs/PatchedUserSourceConnectionRequest.md
create mode 100644 docs/PatchedUserTelegramSourceConnectionRequest.md
create mode 100644 docs/PatchedUserWriteStageRequest.md
create mode 100644 docs/PatchedWSFederationProviderRequest.md
create mode 100644 docs/PatchedWebAuthnDeviceRequest.md
create mode 100644 docs/Permission.md
create mode 100644 docs/PermissionAssignRequest.md
create mode 100644 docs/PermissionAssignResult.md
create mode 100644 docs/PlexAuthenticationChallenge.md
create mode 100644 docs/PlexAuthenticationChallengeResponseRequest.md
create mode 100644 docs/PlexSource.md
create mode 100644 docs/PlexSourcePropertyMapping.md
create mode 100644 docs/PlexSourcePropertyMappingRequest.md
create mode 100644 docs/PlexSourceRequest.md
create mode 100644 docs/PlexTokenRedeemRequest.md
create mode 100644 docs/PoliciesApi.md
create mode 100644 docs/Policy.md
create mode 100644 docs/PolicyBinding.md
create mode 100644 docs/PolicyBindingRequest.md
create mode 100644 docs/PolicyEngineMode.md
create mode 100644 docs/PolicyTestRequest.md
create mode 100644 docs/PolicyTestResult.md
create mode 100644 docs/Process.md
create mode 100644 docs/ProcessRequest.md
create mode 100644 docs/Prompt.md
create mode 100644 docs/PromptChallenge.md
create mode 100644 docs/PromptChallengeResponseRequest.md
create mode 100644 docs/PromptChoice.md
create mode 100644 docs/PromptRequest.md
create mode 100644 docs/PromptStage.md
create mode 100644 docs/PromptStageRequest.md
create mode 100644 docs/PromptTypeEnum.md
create mode 100644 docs/PropertyMapping.md
create mode 100644 docs/PropertyMappingPreview.md
create mode 100644 docs/PropertyMappingTestRequest.md
create mode 100644 docs/PropertyMappingTestResult.md
create mode 100644 docs/PropertymappingsApi.md
create mode 100644 docs/ProtocolEnum.md
create mode 100644 docs/Provider.md
create mode 100644 docs/ProviderEnum.md
create mode 100644 docs/ProviderModelEnum.md
create mode 100644 docs/ProviderTypeEnum.md
create mode 100644 docs/ProvidersApi.md
create mode 100644 docs/ProxyMode.md
create mode 100644 docs/ProxyOutpostConfig.md
create mode 100644 docs/ProxyProvider.md
create mode 100644 docs/ProxyProviderRequest.md
create mode 100644 docs/RACPropertyMapping.md
create mode 100644 docs/RACPropertyMappingRequest.md
create mode 100644 docs/RACProvider.md
create mode 100644 docs/RACProviderRequest.md
create mode 100644 docs/RacApi.md
create mode 100644 docs/RadiusCheckAccess.md
create mode 100644 docs/RadiusOutpostConfig.md
create mode 100644 docs/RadiusProvider.md
create mode 100644 docs/RadiusProviderPropertyMapping.md
create mode 100644 docs/RadiusProviderPropertyMappingRequest.md
create mode 100644 docs/RadiusProviderRequest.md
create mode 100644 docs/RbacApi.md
create mode 100644 docs/RedirectChallenge.md
create mode 100644 docs/RedirectChallengeResponseRequest.md
create mode 100644 docs/RedirectStage.md
create mode 100644 docs/RedirectStageModeEnum.md
create mode 100644 docs/RedirectStageRequest.md
create mode 100644 docs/RedirectURI.md
create mode 100644 docs/RedirectURIRequest.md
create mode 100644 docs/RedirectURITypeEnum.md
create mode 100644 docs/RelatedGroup.md
create mode 100644 docs/RelatedRule.md
create mode 100644 docs/ReportsApi.md
create mode 100644 docs/Reputation.md
create mode 100644 docs/ReputationPolicy.md
create mode 100644 docs/ReputationPolicyRequest.md
create mode 100644 docs/Review.md
create mode 100644 docs/ReviewRequest.md
create mode 100644 docs/ReviewerGroup.md
create mode 100644 docs/ReviewerUser.md
create mode 100644 docs/Role.md
create mode 100644 docs/RoleAssignedObjectPermission.md
create mode 100644 docs/RoleModelPermission.md
create mode 100644 docs/RoleObjectPermission.md
create mode 100644 docs/RoleRequest.md
create mode 100644 docs/RootApi.md
create mode 100644 docs/SAMLBindingsEnum.md
create mode 100644 docs/SAMLLogoutMethods.md
create mode 100644 docs/SAMLMetadata.md
create mode 100644 docs/SAMLNameIDPolicyEnum.md
create mode 100644 docs/SAMLPropertyMapping.md
create mode 100644 docs/SAMLPropertyMappingRequest.md
create mode 100644 docs/SAMLProvider.md
create mode 100644 docs/SAMLProviderRequest.md
create mode 100644 docs/SAMLSource.md
create mode 100644 docs/SAMLSourcePropertyMapping.md
create mode 100644 docs/SAMLSourcePropertyMappingRequest.md
create mode 100644 docs/SAMLSourceRequest.md
create mode 100644 docs/SCIMAuthenticationModeEnum.md
create mode 100644 docs/SCIMMapping.md
create mode 100644 docs/SCIMMappingRequest.md
create mode 100644 docs/SCIMProvider.md
create mode 100644 docs/SCIMProviderGroup.md
create mode 100644 docs/SCIMProviderGroupRequest.md
create mode 100644 docs/SCIMProviderRequest.md
create mode 100644 docs/SCIMProviderUser.md
create mode 100644 docs/SCIMProviderUserRequest.md
create mode 100644 docs/SCIMSource.md
create mode 100644 docs/SCIMSourceGroup.md
create mode 100644 docs/SCIMSourceGroupRequest.md
create mode 100644 docs/SCIMSourcePropertyMapping.md
create mode 100644 docs/SCIMSourcePropertyMappingRequest.md
create mode 100644 docs/SCIMSourceRequest.md
create mode 100644 docs/SCIMSourceUser.md
create mode 100644 docs/SCIMSourceUserRequest.md
create mode 100644 docs/SMSDevice.md
create mode 100644 docs/SMSDeviceRequest.md
create mode 100644 docs/SSFProvider.md
create mode 100644 docs/SSFProviderRequest.md
create mode 100644 docs/SSFStream.md
create mode 100644 docs/SSFStreamStatusEnum.md
create mode 100644 docs/Schedule.md
create mode 100644 docs/ScheduleRequest.md
create mode 100644 docs/SchemaApi.md
create mode 100644 docs/ScopeMapping.md
create mode 100644 docs/ScopeMappingRequest.md
create mode 100644 docs/SelectableStage.md
create mode 100644 docs/ServiceConnection.md
create mode 100644 docs/ServiceConnectionState.md
create mode 100644 docs/SessionEndChallenge.md
create mode 100644 docs/SessionUser.md
create mode 100644 docs/Settings.md
create mode 100644 docs/SettingsRequest.md
create mode 100644 docs/SeverityEnum.md
create mode 100644 docs/ShellChallenge.md
create mode 100644 docs/SignatureAlgorithmEnum.md
create mode 100644 docs/Software.md
create mode 100644 docs/SoftwareRequest.md
create mode 100644 docs/Source.md
create mode 100644 docs/SourceStage.md
create mode 100644 docs/SourceStageRequest.md
create mode 100644 docs/SourceType.md
create mode 100644 docs/SourcesApi.md
create mode 100644 docs/SsfApi.md
create mode 100644 docs/Stage.md
create mode 100644 docs/StageModeEnum.md
create mode 100644 docs/StagePrompt.md
create mode 100644 docs/StagesApi.md
create mode 100644 docs/StaticDevice.md
create mode 100644 docs/StaticDeviceRequest.md
create mode 100644 docs/StaticDeviceToken.md
create mode 100644 docs/SubModeEnum.md
create mode 100644 docs/SyncObjectModelEnum.md
create mode 100644 docs/SyncObjectRequest.md
create mode 100644 docs/SyncObjectResult.md
create mode 100644 docs/SyncOutgoingTriggerModeEnum.md
create mode 100644 docs/SyncStatus.md
create mode 100644 docs/SystemInfo.md
create mode 100644 docs/SystemInfoRuntime.md
create mode 100644 docs/TOTPDevice.md
create mode 100644 docs/TOTPDeviceRequest.md
create mode 100644 docs/Task.md
create mode 100644 docs/TaskAggregatedStatusEnum.md
create mode 100644 docs/TaskStatusEnum.md
create mode 100644 docs/TasksApi.md
create mode 100644 docs/TelegramAuthRequest.md
create mode 100644 docs/TelegramChallengeResponseRequest.md
create mode 100644 docs/TelegramLoginChallenge.md
create mode 100644 docs/TelegramSource.md
create mode 100644 docs/TelegramSourcePropertyMapping.md
create mode 100644 docs/TelegramSourcePropertyMappingRequest.md
create mode 100644 docs/TelegramSourceRequest.md
create mode 100644 docs/Tenant.md
create mode 100644 docs/TenantAdminGroupRequestRequest.md
create mode 100644 docs/TenantRecoveryKeyRequestRequest.md
create mode 100644 docs/TenantRecoveryKeyResponse.md
create mode 100644 docs/TenantRequest.md
create mode 100644 docs/TenantsApi.md
create mode 100644 docs/ThemedUrls.md
create mode 100644 docs/Token.md
create mode 100644 docs/TokenModel.md
create mode 100644 docs/TokenRequest.md
create mode 100644 docs/TokenSetKeyRequest.md
create mode 100644 docs/TokenView.md
create mode 100644 docs/TransactionApplicationRequest.md
create mode 100644 docs/TransactionApplicationResponse.md
create mode 100644 docs/TransactionPolicyBindingRequest.md
create mode 100644 docs/TransportModeEnum.md
create mode 100644 docs/TypeCreate.md
create mode 100644 docs/UiThemeEnum.md
create mode 100644 docs/UniquePasswordPolicy.md
create mode 100644 docs/UniquePasswordPolicyRequest.md
create mode 100644 docs/UsageEnum.md
create mode 100644 docs/UsedBy.md
create mode 100644 docs/UsedByActionEnum.md
create mode 100644 docs/User.md
create mode 100644 docs/UserAccountLockdownRequest.md
create mode 100644 docs/UserAccountRequest.md
create mode 100644 docs/UserAccountSerializerForRoleRequest.md
create mode 100644 docs/UserAttributeEnum.md
create mode 100644 docs/UserConsent.md
create mode 100644 docs/UserCreationModeEnum.md
create mode 100644 docs/UserDeleteStage.md
create mode 100644 docs/UserDeleteStageRequest.md
create mode 100644 docs/UserFieldsEnum.md
create mode 100644 docs/UserKerberosSourceConnection.md
create mode 100644 docs/UserKerberosSourceConnectionRequest.md
create mode 100644 docs/UserLDAPSourceConnection.md
create mode 100644 docs/UserLDAPSourceConnectionRequest.md
create mode 100644 docs/UserLoginChallenge.md
create mode 100644 docs/UserLoginChallengeResponseRequest.md
create mode 100644 docs/UserLoginStage.md
create mode 100644 docs/UserLoginStageRequest.md
create mode 100644 docs/UserLogoutStage.md
create mode 100644 docs/UserLogoutStageRequest.md
create mode 100644 docs/UserMatchingModeEnum.md
create mode 100644 docs/UserOAuthSourceConnection.md
create mode 100644 docs/UserOAuthSourceConnectionRequest.md
create mode 100644 docs/UserPasswordHashSetRequest.md
create mode 100644 docs/UserPasswordSetRequest.md
create mode 100644 docs/UserPath.md
create mode 100644 docs/UserPlexSourceConnection.md
create mode 100644 docs/UserPlexSourceConnectionRequest.md
create mode 100644 docs/UserRecoveryEmailRequest.md
create mode 100644 docs/UserRecoveryLinkRequest.md
create mode 100644 docs/UserRequest.md
create mode 100644 docs/UserSAMLSourceConnection.md
create mode 100644 docs/UserSAMLSourceConnectionRequest.md
create mode 100644 docs/UserSelf.md
create mode 100644 docs/UserSelfGroups.md
create mode 100644 docs/UserSelfRoles.md
create mode 100644 docs/UserServiceAccountRequest.md
create mode 100644 docs/UserServiceAccountResponse.md
create mode 100644 docs/UserSetting.md
create mode 100644 docs/UserSourceConnection.md
create mode 100644 docs/UserSourceConnectionRequest.md
create mode 100644 docs/UserTelegramSourceConnection.md
create mode 100644 docs/UserTelegramSourceConnectionRequest.md
create mode 100644 docs/UserTypeEnum.md
create mode 100644 docs/UserVerificationEnum.md
create mode 100644 docs/UserWriteStage.md
create mode 100644 docs/UserWriteStageRequest.md
create mode 100644 docs/ValidationError.md
create mode 100644 docs/VendorEnum.md
create mode 100644 docs/Version.md
create mode 100644 docs/VersionHistory.md
create mode 100644 docs/WSFederationProvider.md
create mode 100644 docs/WSFederationProviderRequest.md
create mode 100644 docs/WebAuthnDevice.md
create mode 100644 docs/WebAuthnDeviceRequest.md
create mode 100644 docs/WebAuthnDeviceType.md
create mode 100644 docs/WebAuthnHintEnum.md
create mode 100644 docs/Worker.md
create mode 100644 pyproject.toml
create mode 100644 requirements.txt
create mode 100644 schema.yml
create mode 100644 setup.cfg
create mode 100644 setup.py
create mode 100644 test-requirements.txt
create mode 100644 test/__init__.py
create mode 100644 test/test_access_denied_challenge.py
create mode 100644 test/test_account_lockdown_stage.py
create mode 100644 test/test_account_lockdown_stage_request.py
create mode 100644 test/test_admin_api.py
create mode 100644 test/test_agent_authentication_response.py
create mode 100644 test/test_agent_config.py
create mode 100644 test/test_agent_connector.py
create mode 100644 test/test_agent_connector_request.py
create mode 100644 test/test_agent_psso_device_registration_request.py
create mode 100644 test/test_agent_psso_device_registration_response.py
create mode 100644 test/test_agent_psso_user_registration_request.py
create mode 100644 test/test_agent_token_response.py
create mode 100644 test/test_alg_enum.py
create mode 100644 test/test_app.py
create mode 100644 test/test_app_enum.py
create mode 100644 test/test_apple_challenge_response_request.py
create mode 100644 test/test_apple_independent_secure_enclave.py
create mode 100644 test/test_apple_independent_secure_enclave_request.py
create mode 100644 test/test_apple_login_challenge.py
create mode 100644 test/test_application.py
create mode 100644 test/test_application_entitlement.py
create mode 100644 test/test_application_entitlement_request.py
create mode 100644 test/test_application_request.py
create mode 100644 test/test_auth_type_enum.py
create mode 100644 test/test_authenticated_session.py
create mode 100644 test/test_authenticated_session_asn.py
create mode 100644 test/test_authenticated_session_geo_ip.py
create mode 100644 test/test_authenticated_session_user_agent.py
create mode 100644 test/test_authenticated_session_user_agent_device.py
create mode 100644 test/test_authenticated_session_user_agent_os.py
create mode 100644 test/test_authenticated_session_user_agent_user_agent.py
create mode 100644 test/test_authentication_enum.py
create mode 100644 test/test_authenticator_attachment_enum.py
create mode 100644 test/test_authenticator_duo_challenge.py
create mode 100644 test/test_authenticator_duo_challenge_response_request.py
create mode 100644 test/test_authenticator_duo_stage.py
create mode 100644 test/test_authenticator_duo_stage_device_import_response.py
create mode 100644 test/test_authenticator_duo_stage_manual_device_import_request.py
create mode 100644 test/test_authenticator_duo_stage_request.py
create mode 100644 test/test_authenticator_email_challenge.py
create mode 100644 test/test_authenticator_email_challenge_response_request.py
create mode 100644 test/test_authenticator_email_stage.py
create mode 100644 test/test_authenticator_email_stage_request.py
create mode 100644 test/test_authenticator_endpoint_gdtc_stage.py
create mode 100644 test/test_authenticator_endpoint_gdtc_stage_request.py
create mode 100644 test/test_authenticator_sms_challenge.py
create mode 100644 test/test_authenticator_sms_challenge_response_request.py
create mode 100644 test/test_authenticator_sms_stage.py
create mode 100644 test/test_authenticator_sms_stage_request.py
create mode 100644 test/test_authenticator_static_challenge.py
create mode 100644 test/test_authenticator_static_challenge_response_request.py
create mode 100644 test/test_authenticator_static_stage.py
create mode 100644 test/test_authenticator_static_stage_request.py
create mode 100644 test/test_authenticator_totp_challenge.py
create mode 100644 test/test_authenticator_totp_challenge_response_request.py
create mode 100644 test/test_authenticator_totp_stage.py
create mode 100644 test/test_authenticator_totp_stage_request.py
create mode 100644 test/test_authenticator_validate_stage.py
create mode 100644 test/test_authenticator_validate_stage_request.py
create mode 100644 test/test_authenticator_validation_challenge.py
create mode 100644 test/test_authenticator_validation_challenge_response_request.py
create mode 100644 test/test_authenticator_web_authn_challenge.py
create mode 100644 test/test_authenticator_web_authn_challenge_response_request.py
create mode 100644 test/test_authenticator_web_authn_stage.py
create mode 100644 test/test_authenticator_web_authn_stage_request.py
create mode 100644 test/test_authenticators_api.py
create mode 100644 test/test_authorization_code_auth_method_enum.py
create mode 100644 test/test_auto_submit_challenge_response_request.py
create mode 100644 test/test_autosubmit_challenge.py
create mode 100644 test/test_backends_enum.py
create mode 100644 test/test_binding_type_enum.py
create mode 100644 test/test_blueprint_file.py
create mode 100644 test/test_blueprint_import_result.py
create mode 100644 test/test_blueprint_instance.py
create mode 100644 test/test_blueprint_instance_request.py
create mode 100644 test/test_blueprint_instance_status_enum.py
create mode 100644 test/test_brand.py
create mode 100644 test/test_brand_request.py
create mode 100644 test/test_bulk_delete_session_response.py
create mode 100644 test/test_cache.py
create mode 100644 test/test_capabilities_enum.py
create mode 100644 test/test_captcha_challenge.py
create mode 100644 test/test_captcha_challenge_response_request.py
create mode 100644 test/test_captcha_stage.py
create mode 100644 test/test_captcha_stage_request.py
create mode 100644 test/test_cert_attribute_enum.py
create mode 100644 test/test_certificate_data.py
create mode 100644 test/test_certificate_generation_request.py
create mode 100644 test/test_certificate_key_pair.py
create mode 100644 test/test_certificate_key_pair_key_type_enum.py
create mode 100644 test/test_certificate_key_pair_request.py
create mode 100644 test/test_challenge_types.py
create mode 100644 test/test_client_type_enum.py
create mode 100644 test/test_compatibility_mode_enum.py
create mode 100644 test/test_config.py
create mode 100644 test/test_connection_token.py
create mode 100644 test/test_connection_token_request.py
create mode 100644 test/test_connector.py
create mode 100644 test/test_consent_challenge.py
create mode 100644 test/test_consent_challenge_response_request.py
create mode 100644 test/test_consent_mode_enum.py
create mode 100644 test/test_consent_permission.py
create mode 100644 test/test_consent_stage.py
create mode 100644 test/test_consent_stage_request.py
create mode 100644 test/test_content_type.py
create mode 100644 test/test_content_type_enum.py
create mode 100644 test/test_contextual_flow_info.py
create mode 100644 test/test_contextual_flow_info_layout_enum.py
create mode 100644 test/test_core_api.py
create mode 100644 test/test_country_code_enum.py
create mode 100644 test/test_crypto_api.py
create mode 100644 test/test_current_brand.py
create mode 100644 test/test_current_brand_flags.py
create mode 100644 test/test_data_export.py
create mode 100644 test/test_delivery_method_enum.py
create mode 100644 test/test_denied_action_enum.py
create mode 100644 test/test_deny_stage.py
create mode 100644 test/test_deny_stage_request.py
create mode 100644 test/test_detailed_country.py
create mode 100644 test/test_device.py
create mode 100644 test/test_device_access_group.py
create mode 100644 test/test_device_access_group_request.py
create mode 100644 test/test_device_challenge.py
create mode 100644 test/test_device_challenge_request.py
create mode 100644 test/test_device_classes_enum.py
create mode 100644 test/test_device_connection.py
create mode 100644 test/test_device_fact_snapshot.py
create mode 100644 test/test_device_facts.py
create mode 100644 test/test_device_facts_os_family.py
create mode 100644 test/test_device_facts_request.py
create mode 100644 test/test_device_group.py
create mode 100644 test/test_device_group_request.py
create mode 100644 test/test_device_summary.py
create mode 100644 test/test_device_user.py
create mode 100644 test/test_device_user_binding.py
create mode 100644 test/test_device_user_binding_request.py
create mode 100644 test/test_device_user_request.py
create mode 100644 test/test_digest_algorithm_enum.py
create mode 100644 test/test_digits_enum.py
create mode 100644 test/test_disk.py
create mode 100644 test/test_disk_request.py
create mode 100644 test/test_docker_service_connection.py
create mode 100644 test/test_docker_service_connection_request.py
create mode 100644 test/test_domain.py
create mode 100644 test/test_domain_request.py
create mode 100644 test/test_dummy_challenge.py
create mode 100644 test/test_dummy_challenge_response_request.py
create mode 100644 test/test_dummy_policy.py
create mode 100644 test/test_dummy_policy_request.py
create mode 100644 test/test_dummy_stage.py
create mode 100644 test/test_dummy_stage_request.py
create mode 100644 test/test_duo_device.py
create mode 100644 test/test_duo_device_enrollment_status.py
create mode 100644 test/test_duo_device_request.py
create mode 100644 test/test_duo_response_enum.py
create mode 100644 test/test_email_challenge.py
create mode 100644 test/test_email_challenge_response_request.py
create mode 100644 test/test_email_device.py
create mode 100644 test/test_email_device_request.py
create mode 100644 test/test_email_stage.py
create mode 100644 test/test_email_stage_request.py
create mode 100644 test/test_endpoint.py
create mode 100644 test/test_endpoint_agent_challenge.py
create mode 100644 test/test_endpoint_agent_challenge_response_request.py
create mode 100644 test/test_endpoint_auth_mode_enum.py
create mode 100644 test/test_endpoint_device.py
create mode 100644 test/test_endpoint_device_details.py
create mode 100644 test/test_endpoint_device_request.py
create mode 100644 test/test_endpoint_request.py
create mode 100644 test/test_endpoint_stage.py
create mode 100644 test/test_endpoint_stage_request.py
create mode 100644 test/test_endpoints_api.py
create mode 100644 test/test_enroll_request.py
create mode 100644 test/test_enrollment_token.py
create mode 100644 test/test_enrollment_token_request.py
create mode 100644 test/test_enterprise_api.py
create mode 100644 test/test_error_detail.py
create mode 100644 test/test_error_reporting_config.py
create mode 100644 test/test_event.py
create mode 100644 test/test_event_actions.py
create mode 100644 test/test_event_matcher_policy.py
create mode 100644 test/test_event_matcher_policy_request.py
create mode 100644 test/test_event_request.py
create mode 100644 test/test_event_stats.py
create mode 100644 test/test_event_top_per_user.py
create mode 100644 test/test_event_volume.py
create mode 100644 test/test_events_api.py
create mode 100644 test/test_events_requested_enum.py
create mode 100644 test/test_expiring_base_grant_model.py
create mode 100644 test/test_expression_policy.py
create mode 100644 test/test_expression_policy_request.py
create mode 100644 test/test_extra_role_object_permission.py
create mode 100644 test/test_file_list.py
create mode 100644 test/test_fleet_connector.py
create mode 100644 test/test_fleet_connector_request.py
create mode 100644 test/test_flow.py
create mode 100644 test/test_flow_challenge_response_request.py
create mode 100644 test/test_flow_designation_enum.py
create mode 100644 test/test_flow_diagram.py
create mode 100644 test/test_flow_error_challenge.py
create mode 100644 test/test_flow_inspection.py
create mode 100644 test/test_flow_inspector_plan.py
create mode 100644 test/test_flow_layout_enum.py
create mode 100644 test/test_flow_request.py
create mode 100644 test/test_flow_set.py
create mode 100644 test/test_flow_stage_binding.py
create mode 100644 test/test_flow_stage_binding_request.py
create mode 100644 test/test_flows_api.py
create mode 100644 test/test_footer_link.py
create mode 100644 test/test_force_binding_enum.py
create mode 100644 test/test_format_enum.py
create mode 100644 test/test_frame_challenge.py
create mode 100644 test/test_frame_challenge_response_request.py
create mode 100644 test/test_generic_error.py
create mode 100644 test/test_geo_ip_policy.py
create mode 100644 test/test_geo_ip_policy_countries_obj_inner.py
create mode 100644 test/test_geo_ip_policy_request.py
create mode 100644 test/test_geoip_binding_enum.py
create mode 100644 test/test_global_task_status.py
create mode 100644 test/test_google_chrome_connector.py
create mode 100644 test/test_google_chrome_connector_request.py
create mode 100644 test/test_google_endpoint_device.py
create mode 100644 test/test_google_endpoint_device_request.py
create mode 100644 test/test_google_workspace_provider.py
create mode 100644 test/test_google_workspace_provider_group.py
create mode 100644 test/test_google_workspace_provider_group_request.py
create mode 100644 test/test_google_workspace_provider_mapping.py
create mode 100644 test/test_google_workspace_provider_mapping_request.py
create mode 100644 test/test_google_workspace_provider_request.py
create mode 100644 test/test_google_workspace_provider_user.py
create mode 100644 test/test_google_workspace_provider_user_request.py
create mode 100644 test/test_grant_types_enum.py
create mode 100644 test/test_group.py
create mode 100644 test/test_group_kerberos_source_connection.py
create mode 100644 test/test_group_kerberos_source_connection_request.py
create mode 100644 test/test_group_ldap_source_connection.py
create mode 100644 test/test_group_ldap_source_connection_request.py
create mode 100644 test/test_group_matching_mode_enum.py
create mode 100644 test/test_group_o_auth_source_connection.py
create mode 100644 test/test_group_o_auth_source_connection_request.py
create mode 100644 test/test_group_plex_source_connection.py
create mode 100644 test/test_group_plex_source_connection_request.py
create mode 100644 test/test_group_request.py
create mode 100644 test/test_group_saml_source_connection.py
create mode 100644 test/test_group_saml_source_connection_request.py
create mode 100644 test/test_group_source_connection.py
create mode 100644 test/test_group_source_connection_request.py
create mode 100644 test/test_group_telegram_source_connection.py
create mode 100644 test/test_group_telegram_source_connection_request.py
create mode 100644 test/test_hardware.py
create mode 100644 test/test_hardware_request.py
create mode 100644 test/test_identification_challenge.py
create mode 100644 test/test_identification_challenge_response_request.py
create mode 100644 test/test_identification_stage.py
create mode 100644 test/test_identification_stage_request.py
create mode 100644 test/test_iframe_logout_challenge.py
create mode 100644 test/test_iframe_logout_challenge_response_request.py
create mode 100644 test/test_impersonation_request.py
create mode 100644 test/test_initial_permissions.py
create mode 100644 test/test_initial_permissions_request.py
create mode 100644 test/test_install_id.py
create mode 100644 test/test_intent_enum.py
create mode 100644 test/test_invalid_response_action_enum.py
create mode 100644 test/test_invitation.py
create mode 100644 test/test_invitation_request.py
create mode 100644 test/test_invitation_send_email_request.py
create mode 100644 test/test_invitation_stage.py
create mode 100644 test/test_invitation_stage_request.py
create mode 100644 test/test_issuer_mode_enum.py
create mode 100644 test/test_kadmin_type_enum.py
create mode 100644 test/test_kerberos_source.py
create mode 100644 test/test_kerberos_source_property_mapping.py
create mode 100644 test/test_kerberos_source_property_mapping_request.py
create mode 100644 test/test_kerberos_source_request.py
create mode 100644 test/test_key_type_enum.py
create mode 100644 test/test_kubernetes_service_connection.py
create mode 100644 test/test_kubernetes_service_connection_request.py
create mode 100644 test/test_lang_enum.py
create mode 100644 test/test_last_task_status_enum.py
create mode 100644 test/test_ldap_check_access.py
create mode 100644 test/test_ldap_debug.py
create mode 100644 test/test_ldap_outpost_config.py
create mode 100644 test/test_ldap_provider.py
create mode 100644 test/test_ldap_provider_request.py
create mode 100644 test/test_ldap_source.py
create mode 100644 test/test_ldap_source_property_mapping.py
create mode 100644 test/test_ldap_source_property_mapping_request.py
create mode 100644 test/test_ldap_source_request.py
create mode 100644 test/test_ldapapi_access_mode.py
create mode 100644 test/test_license.py
create mode 100644 test/test_license_flags_enum.py
create mode 100644 test/test_license_forecast.py
create mode 100644 test/test_license_request.py
create mode 100644 test/test_license_status_enum.py
create mode 100644 test/test_license_summary.py
create mode 100644 test/test_license_summary_status_enum.py
create mode 100644 test/test_lifecycle_api.py
create mode 100644 test/test_lifecycle_iteration.py
create mode 100644 test/test_lifecycle_iteration_request.py
create mode 100644 test/test_lifecycle_iteration_state_enum.py
create mode 100644 test/test_lifecycle_rule.py
create mode 100644 test/test_lifecycle_rule_request.py
create mode 100644 test/test_link.py
create mode 100644 test/test_log_event.py
create mode 100644 test/test_log_level_enum.py
create mode 100644 test/test_login_challenge_types.py
create mode 100644 test/test_login_source.py
create mode 100644 test/test_logout_url.py
create mode 100644 test/test_managed_api.py
create mode 100644 test/test_matching_mode_enum.py
create mode 100644 test/test_mdm_config_request.py
create mode 100644 test/test_mdm_config_response.py
create mode 100644 test/test_metadata.py
create mode 100644 test/test_microsoft_entra_provider.py
create mode 100644 test/test_microsoft_entra_provider_group.py
create mode 100644 test/test_microsoft_entra_provider_group_request.py
create mode 100644 test/test_microsoft_entra_provider_mapping.py
create mode 100644 test/test_microsoft_entra_provider_mapping_request.py
create mode 100644 test/test_microsoft_entra_provider_request.py
create mode 100644 test/test_microsoft_entra_provider_user.py
create mode 100644 test/test_microsoft_entra_provider_user_request.py
create mode 100644 test/test_model_enum.py
create mode 100644 test/test_model_request.py
create mode 100644 test/test_mutual_tls_stage.py
create mode 100644 test/test_mutual_tls_stage_request.py
create mode 100644 test/test_native_logout_challenge.py
create mode 100644 test/test_native_logout_challenge_response_request.py
create mode 100644 test/test_network.py
create mode 100644 test/test_network_binding_enum.py
create mode 100644 test/test_network_interface.py
create mode 100644 test/test_network_interface_request.py
create mode 100644 test/test_network_request.py
create mode 100644 test/test_not_configured_action_enum.py
create mode 100644 test/test_notification.py
create mode 100644 test/test_notification_request.py
create mode 100644 test/test_notification_rule.py
create mode 100644 test/test_notification_rule_request.py
create mode 100644 test/test_notification_transport.py
create mode 100644 test/test_notification_transport_request.py
create mode 100644 test/test_notification_transport_test.py
create mode 100644 test/test_notification_webhook_mapping.py
create mode 100644 test/test_notification_webhook_mapping_request.py
create mode 100644 test/test_o_auth2_provider.py
create mode 100644 test/test_o_auth2_provider_logout_method_enum.py
create mode 100644 test/test_o_auth2_provider_request.py
create mode 100644 test/test_o_auth2_provider_setup_urls.py
create mode 100644 test/test_o_auth_device_code_challenge.py
create mode 100644 test/test_o_auth_device_code_challenge_response_request.py
create mode 100644 test/test_o_auth_device_code_finish_challenge.py
create mode 100644 test/test_o_auth_device_code_finish_challenge_response_request.py
create mode 100644 test/test_o_auth_source.py
create mode 100644 test/test_o_auth_source_property_mapping.py
create mode 100644 test/test_o_auth_source_property_mapping_request.py
create mode 100644 test/test_o_auth_source_request.py
create mode 100644 test/test_oauth2_api.py
create mode 100644 test/test_open_id_connect_configuration.py
create mode 100644 test/test_operating_system.py
create mode 100644 test/test_operating_system_request.py
create mode 100644 test/test_outgoing_sync_delete_action.py
create mode 100644 test/test_outpost.py
create mode 100644 test/test_outpost_default_config.py
create mode 100644 test/test_outpost_health.py
create mode 100644 test/test_outpost_request.py
create mode 100644 test/test_outpost_type_enum.py
create mode 100644 test/test_outposts_api.py
create mode 100644 test/test_paginated_account_lockdown_stage_list.py
create mode 100644 test/test_paginated_agent_connector_list.py
create mode 100644 test/test_paginated_apple_independent_secure_enclave_list.py
create mode 100644 test/test_paginated_application_entitlement_list.py
create mode 100644 test/test_paginated_application_list.py
create mode 100644 test/test_paginated_authenticated_session_list.py
create mode 100644 test/test_paginated_authenticator_duo_stage_list.py
create mode 100644 test/test_paginated_authenticator_email_stage_list.py
create mode 100644 test/test_paginated_authenticator_endpoint_gdtc_stage_list.py
create mode 100644 test/test_paginated_authenticator_sms_stage_list.py
create mode 100644 test/test_paginated_authenticator_static_stage_list.py
create mode 100644 test/test_paginated_authenticator_totp_stage_list.py
create mode 100644 test/test_paginated_authenticator_validate_stage_list.py
create mode 100644 test/test_paginated_authenticator_web_authn_stage_list.py
create mode 100644 test/test_paginated_blueprint_instance_list.py
create mode 100644 test/test_paginated_brand_list.py
create mode 100644 test/test_paginated_captcha_stage_list.py
create mode 100644 test/test_paginated_certificate_key_pair_list.py
create mode 100644 test/test_paginated_connection_token_list.py
create mode 100644 test/test_paginated_connector_list.py
create mode 100644 test/test_paginated_consent_stage_list.py
create mode 100644 test/test_paginated_data_export_list.py
create mode 100644 test/test_paginated_deny_stage_list.py
create mode 100644 test/test_paginated_device_access_group_list.py
create mode 100644 test/test_paginated_device_user_binding_list.py
create mode 100644 test/test_paginated_docker_service_connection_list.py
create mode 100644 test/test_paginated_domain_list.py
create mode 100644 test/test_paginated_dummy_policy_list.py
create mode 100644 test/test_paginated_dummy_stage_list.py
create mode 100644 test/test_paginated_duo_device_list.py
create mode 100644 test/test_paginated_email_device_list.py
create mode 100644 test/test_paginated_email_stage_list.py
create mode 100644 test/test_paginated_endpoint_device_list.py
create mode 100644 test/test_paginated_endpoint_list.py
create mode 100644 test/test_paginated_endpoint_stage_list.py
create mode 100644 test/test_paginated_enrollment_token_list.py
create mode 100644 test/test_paginated_event_list.py
create mode 100644 test/test_paginated_event_matcher_policy_list.py
create mode 100644 test/test_paginated_expiring_base_grant_model_list.py
create mode 100644 test/test_paginated_expression_policy_list.py
create mode 100644 test/test_paginated_extra_role_object_permission_list.py
create mode 100644 test/test_paginated_fleet_connector_list.py
create mode 100644 test/test_paginated_flow_list.py
create mode 100644 test/test_paginated_flow_stage_binding_list.py
create mode 100644 test/test_paginated_geo_ip_policy_list.py
create mode 100644 test/test_paginated_google_chrome_connector_list.py
create mode 100644 test/test_paginated_google_endpoint_device_list.py
create mode 100644 test/test_paginated_google_workspace_provider_group_list.py
create mode 100644 test/test_paginated_google_workspace_provider_list.py
create mode 100644 test/test_paginated_google_workspace_provider_mapping_list.py
create mode 100644 test/test_paginated_google_workspace_provider_user_list.py
create mode 100644 test/test_paginated_group_kerberos_source_connection_list.py
create mode 100644 test/test_paginated_group_ldap_source_connection_list.py
create mode 100644 test/test_paginated_group_list.py
create mode 100644 test/test_paginated_group_o_auth_source_connection_list.py
create mode 100644 test/test_paginated_group_plex_source_connection_list.py
create mode 100644 test/test_paginated_group_saml_source_connection_list.py
create mode 100644 test/test_paginated_group_source_connection_list.py
create mode 100644 test/test_paginated_group_telegram_source_connection_list.py
create mode 100644 test/test_paginated_identification_stage_list.py
create mode 100644 test/test_paginated_initial_permissions_list.py
create mode 100644 test/test_paginated_invitation_list.py
create mode 100644 test/test_paginated_invitation_stage_list.py
create mode 100644 test/test_paginated_kerberos_source_list.py
create mode 100644 test/test_paginated_kerberos_source_property_mapping_list.py
create mode 100644 test/test_paginated_kubernetes_service_connection_list.py
create mode 100644 test/test_paginated_ldap_outpost_config_list.py
create mode 100644 test/test_paginated_ldap_provider_list.py
create mode 100644 test/test_paginated_ldap_source_list.py
create mode 100644 test/test_paginated_ldap_source_property_mapping_list.py
create mode 100644 test/test_paginated_license_list.py
create mode 100644 test/test_paginated_lifecycle_iteration_list.py
create mode 100644 test/test_paginated_lifecycle_rule_list.py
create mode 100644 test/test_paginated_microsoft_entra_provider_group_list.py
create mode 100644 test/test_paginated_microsoft_entra_provider_list.py
create mode 100644 test/test_paginated_microsoft_entra_provider_mapping_list.py
create mode 100644 test/test_paginated_microsoft_entra_provider_user_list.py
create mode 100644 test/test_paginated_mutual_tls_stage_list.py
create mode 100644 test/test_paginated_notification_list.py
create mode 100644 test/test_paginated_notification_rule_list.py
create mode 100644 test/test_paginated_notification_transport_list.py
create mode 100644 test/test_paginated_notification_webhook_mapping_list.py
create mode 100644 test/test_paginated_o_auth2_provider_list.py
create mode 100644 test/test_paginated_o_auth_source_list.py
create mode 100644 test/test_paginated_o_auth_source_property_mapping_list.py
create mode 100644 test/test_paginated_outpost_list.py
create mode 100644 test/test_paginated_password_expiry_policy_list.py
create mode 100644 test/test_paginated_password_policy_list.py
create mode 100644 test/test_paginated_password_stage_list.py
create mode 100644 test/test_paginated_permission_list.py
create mode 100644 test/test_paginated_plex_source_list.py
create mode 100644 test/test_paginated_plex_source_property_mapping_list.py
create mode 100644 test/test_paginated_policy_binding_list.py
create mode 100644 test/test_paginated_policy_list.py
create mode 100644 test/test_paginated_prompt_list.py
create mode 100644 test/test_paginated_prompt_stage_list.py
create mode 100644 test/test_paginated_property_mapping_list.py
create mode 100644 test/test_paginated_provider_list.py
create mode 100644 test/test_paginated_proxy_outpost_config_list.py
create mode 100644 test/test_paginated_proxy_provider_list.py
create mode 100644 test/test_paginated_rac_property_mapping_list.py
create mode 100644 test/test_paginated_rac_provider_list.py
create mode 100644 test/test_paginated_radius_outpost_config_list.py
create mode 100644 test/test_paginated_radius_provider_list.py
create mode 100644 test/test_paginated_radius_provider_property_mapping_list.py
create mode 100644 test/test_paginated_redirect_stage_list.py
create mode 100644 test/test_paginated_reputation_list.py
create mode 100644 test/test_paginated_reputation_policy_list.py
create mode 100644 test/test_paginated_role_assigned_object_permission_list.py
create mode 100644 test/test_paginated_role_list.py
create mode 100644 test/test_paginated_saml_property_mapping_list.py
create mode 100644 test/test_paginated_saml_provider_list.py
create mode 100644 test/test_paginated_saml_source_list.py
create mode 100644 test/test_paginated_saml_source_property_mapping_list.py
create mode 100644 test/test_paginated_schedule_list.py
create mode 100644 test/test_paginated_scim_mapping_list.py
create mode 100644 test/test_paginated_scim_provider_group_list.py
create mode 100644 test/test_paginated_scim_provider_list.py
create mode 100644 test/test_paginated_scim_provider_user_list.py
create mode 100644 test/test_paginated_scim_source_group_list.py
create mode 100644 test/test_paginated_scim_source_list.py
create mode 100644 test/test_paginated_scim_source_property_mapping_list.py
create mode 100644 test/test_paginated_scim_source_user_list.py
create mode 100644 test/test_paginated_scope_mapping_list.py
create mode 100644 test/test_paginated_service_connection_list.py
create mode 100644 test/test_paginated_sms_device_list.py
create mode 100644 test/test_paginated_source_list.py
create mode 100644 test/test_paginated_source_stage_list.py
create mode 100644 test/test_paginated_ssf_provider_list.py
create mode 100644 test/test_paginated_ssf_stream_list.py
create mode 100644 test/test_paginated_stage_list.py
create mode 100644 test/test_paginated_static_device_list.py
create mode 100644 test/test_paginated_task_list.py
create mode 100644 test/test_paginated_telegram_source_list.py
create mode 100644 test/test_paginated_telegram_source_property_mapping_list.py
create mode 100644 test/test_paginated_tenant_list.py
create mode 100644 test/test_paginated_token_list.py
create mode 100644 test/test_paginated_token_model_list.py
create mode 100644 test/test_paginated_totp_device_list.py
create mode 100644 test/test_paginated_unique_password_policy_list.py
create mode 100644 test/test_paginated_user_consent_list.py
create mode 100644 test/test_paginated_user_delete_stage_list.py
create mode 100644 test/test_paginated_user_kerberos_source_connection_list.py
create mode 100644 test/test_paginated_user_ldap_source_connection_list.py
create mode 100644 test/test_paginated_user_list.py
create mode 100644 test/test_paginated_user_login_stage_list.py
create mode 100644 test/test_paginated_user_logout_stage_list.py
create mode 100644 test/test_paginated_user_o_auth_source_connection_list.py
create mode 100644 test/test_paginated_user_plex_source_connection_list.py
create mode 100644 test/test_paginated_user_saml_source_connection_list.py
create mode 100644 test/test_paginated_user_source_connection_list.py
create mode 100644 test/test_paginated_user_telegram_source_connection_list.py
create mode 100644 test/test_paginated_user_write_stage_list.py
create mode 100644 test/test_paginated_web_authn_device_list.py
create mode 100644 test/test_paginated_web_authn_device_type_list.py
create mode 100644 test/test_paginated_ws_federation_provider_list.py
create mode 100644 test/test_pagination.py
create mode 100644 test/test_partial_group.py
create mode 100644 test/test_partial_user.py
create mode 100644 test/test_password_challenge.py
create mode 100644 test/test_password_challenge_response_request.py
create mode 100644 test/test_password_expiry_policy.py
create mode 100644 test/test_password_expiry_policy_request.py
create mode 100644 test/test_password_policy.py
create mode 100644 test/test_password_policy_request.py
create mode 100644 test/test_password_stage.py
create mode 100644 test/test_password_stage_request.py
create mode 100644 test/test_patched_account_lockdown_stage_request.py
create mode 100644 test/test_patched_agent_connector_request.py
create mode 100644 test/test_patched_apple_independent_secure_enclave_request.py
create mode 100644 test/test_patched_application_entitlement_request.py
create mode 100644 test/test_patched_application_request.py
create mode 100644 test/test_patched_authenticator_duo_stage_request.py
create mode 100644 test/test_patched_authenticator_email_stage_request.py
create mode 100644 test/test_patched_authenticator_endpoint_gdtc_stage_request.py
create mode 100644 test/test_patched_authenticator_sms_stage_request.py
create mode 100644 test/test_patched_authenticator_static_stage_request.py
create mode 100644 test/test_patched_authenticator_totp_stage_request.py
create mode 100644 test/test_patched_authenticator_validate_stage_request.py
create mode 100644 test/test_patched_authenticator_web_authn_stage_request.py
create mode 100644 test/test_patched_blueprint_instance_request.py
create mode 100644 test/test_patched_brand_request.py
create mode 100644 test/test_patched_captcha_stage_request.py
create mode 100644 test/test_patched_certificate_key_pair_request.py
create mode 100644 test/test_patched_connection_token_request.py
create mode 100644 test/test_patched_consent_stage_request.py
create mode 100644 test/test_patched_deny_stage_request.py
create mode 100644 test/test_patched_device_access_group_request.py
create mode 100644 test/test_patched_device_user_binding_request.py
create mode 100644 test/test_patched_docker_service_connection_request.py
create mode 100644 test/test_patched_domain_request.py
create mode 100644 test/test_patched_dummy_policy_request.py
create mode 100644 test/test_patched_dummy_stage_request.py
create mode 100644 test/test_patched_duo_device_request.py
create mode 100644 test/test_patched_email_device_request.py
create mode 100644 test/test_patched_email_stage_request.py
create mode 100644 test/test_patched_endpoint_device_request.py
create mode 100644 test/test_patched_endpoint_request.py
create mode 100644 test/test_patched_endpoint_stage_request.py
create mode 100644 test/test_patched_enrollment_token_request.py
create mode 100644 test/test_patched_event_matcher_policy_request.py
create mode 100644 test/test_patched_event_request.py
create mode 100644 test/test_patched_expression_policy_request.py
create mode 100644 test/test_patched_fleet_connector_request.py
create mode 100644 test/test_patched_flow_request.py
create mode 100644 test/test_patched_flow_stage_binding_request.py
create mode 100644 test/test_patched_geo_ip_policy_request.py
create mode 100644 test/test_patched_google_chrome_connector_request.py
create mode 100644 test/test_patched_google_endpoint_device_request.py
create mode 100644 test/test_patched_google_workspace_provider_mapping_request.py
create mode 100644 test/test_patched_google_workspace_provider_request.py
create mode 100644 test/test_patched_group_kerberos_source_connection_request.py
create mode 100644 test/test_patched_group_ldap_source_connection_request.py
create mode 100644 test/test_patched_group_o_auth_source_connection_request.py
create mode 100644 test/test_patched_group_plex_source_connection_request.py
create mode 100644 test/test_patched_group_request.py
create mode 100644 test/test_patched_group_saml_source_connection_request.py
create mode 100644 test/test_patched_group_source_connection_request.py
create mode 100644 test/test_patched_group_telegram_source_connection_request.py
create mode 100644 test/test_patched_identification_stage_request.py
create mode 100644 test/test_patched_initial_permissions_request.py
create mode 100644 test/test_patched_invitation_request.py
create mode 100644 test/test_patched_invitation_stage_request.py
create mode 100644 test/test_patched_kerberos_source_property_mapping_request.py
create mode 100644 test/test_patched_kerberos_source_request.py
create mode 100644 test/test_patched_kubernetes_service_connection_request.py
create mode 100644 test/test_patched_ldap_provider_request.py
create mode 100644 test/test_patched_ldap_source_property_mapping_request.py
create mode 100644 test/test_patched_ldap_source_request.py
create mode 100644 test/test_patched_license_request.py
create mode 100644 test/test_patched_lifecycle_rule_request.py
create mode 100644 test/test_patched_microsoft_entra_provider_mapping_request.py
create mode 100644 test/test_patched_microsoft_entra_provider_request.py
create mode 100644 test/test_patched_mutual_tls_stage_request.py
create mode 100644 test/test_patched_notification_request.py
create mode 100644 test/test_patched_notification_rule_request.py
create mode 100644 test/test_patched_notification_transport_request.py
create mode 100644 test/test_patched_notification_webhook_mapping_request.py
create mode 100644 test/test_patched_o_auth2_provider_request.py
create mode 100644 test/test_patched_o_auth_source_property_mapping_request.py
create mode 100644 test/test_patched_o_auth_source_request.py
create mode 100644 test/test_patched_outpost_request.py
create mode 100644 test/test_patched_password_expiry_policy_request.py
create mode 100644 test/test_patched_password_policy_request.py
create mode 100644 test/test_patched_password_stage_request.py
create mode 100644 test/test_patched_permission_assign_request.py
create mode 100644 test/test_patched_plex_source_property_mapping_request.py
create mode 100644 test/test_patched_plex_source_request.py
create mode 100644 test/test_patched_policy_binding_request.py
create mode 100644 test/test_patched_prompt_request.py
create mode 100644 test/test_patched_prompt_stage_request.py
create mode 100644 test/test_patched_proxy_provider_request.py
create mode 100644 test/test_patched_rac_property_mapping_request.py
create mode 100644 test/test_patched_rac_provider_request.py
create mode 100644 test/test_patched_radius_provider_property_mapping_request.py
create mode 100644 test/test_patched_radius_provider_request.py
create mode 100644 test/test_patched_redirect_stage_request.py
create mode 100644 test/test_patched_reputation_policy_request.py
create mode 100644 test/test_patched_role_request.py
create mode 100644 test/test_patched_saml_property_mapping_request.py
create mode 100644 test/test_patched_saml_provider_request.py
create mode 100644 test/test_patched_saml_source_property_mapping_request.py
create mode 100644 test/test_patched_saml_source_request.py
create mode 100644 test/test_patched_schedule_request.py
create mode 100644 test/test_patched_scim_mapping_request.py
create mode 100644 test/test_patched_scim_provider_request.py
create mode 100644 test/test_patched_scim_source_group_request.py
create mode 100644 test/test_patched_scim_source_property_mapping_request.py
create mode 100644 test/test_patched_scim_source_request.py
create mode 100644 test/test_patched_scim_source_user_request.py
create mode 100644 test/test_patched_scope_mapping_request.py
create mode 100644 test/test_patched_settings_request.py
create mode 100644 test/test_patched_settings_request_flags.py
create mode 100644 test/test_patched_sms_device_request.py
create mode 100644 test/test_patched_source_stage_request.py
create mode 100644 test/test_patched_ssf_provider_request.py
create mode 100644 test/test_patched_static_device_request.py
create mode 100644 test/test_patched_telegram_source_property_mapping_request.py
create mode 100644 test/test_patched_telegram_source_request.py
create mode 100644 test/test_patched_tenant_request.py
create mode 100644 test/test_patched_token_request.py
create mode 100644 test/test_patched_totp_device_request.py
create mode 100644 test/test_patched_unique_password_policy_request.py
create mode 100644 test/test_patched_user_delete_stage_request.py
create mode 100644 test/test_patched_user_kerberos_source_connection_request.py
create mode 100644 test/test_patched_user_ldap_source_connection_request.py
create mode 100644 test/test_patched_user_login_stage_request.py
create mode 100644 test/test_patched_user_logout_stage_request.py
create mode 100644 test/test_patched_user_o_auth_source_connection_request.py
create mode 100644 test/test_patched_user_plex_source_connection_request.py
create mode 100644 test/test_patched_user_request.py
create mode 100644 test/test_patched_user_saml_source_connection_request.py
create mode 100644 test/test_patched_user_source_connection_request.py
create mode 100644 test/test_patched_user_telegram_source_connection_request.py
create mode 100644 test/test_patched_user_write_stage_request.py
create mode 100644 test/test_patched_web_authn_device_request.py
create mode 100644 test/test_patched_ws_federation_provider_request.py
create mode 100644 test/test_permission.py
create mode 100644 test/test_permission_assign_request.py
create mode 100644 test/test_permission_assign_result.py
create mode 100644 test/test_pkce_method_enum.py
create mode 100644 test/test_plex_authentication_challenge.py
create mode 100644 test/test_plex_authentication_challenge_response_request.py
create mode 100644 test/test_plex_source.py
create mode 100644 test/test_plex_source_property_mapping.py
create mode 100644 test/test_plex_source_property_mapping_request.py
create mode 100644 test/test_plex_source_request.py
create mode 100644 test/test_plex_token_redeem_request.py
create mode 100644 test/test_policies_api.py
create mode 100644 test/test_policy.py
create mode 100644 test/test_policy_binding.py
create mode 100644 test/test_policy_binding_request.py
create mode 100644 test/test_policy_engine_mode.py
create mode 100644 test/test_policy_test_request.py
create mode 100644 test/test_policy_test_result.py
create mode 100644 test/test_process.py
create mode 100644 test/test_process_request.py
create mode 100644 test/test_prompt.py
create mode 100644 test/test_prompt_challenge.py
create mode 100644 test/test_prompt_challenge_response_request.py
create mode 100644 test/test_prompt_choice.py
create mode 100644 test/test_prompt_request.py
create mode 100644 test/test_prompt_stage.py
create mode 100644 test/test_prompt_stage_request.py
create mode 100644 test/test_prompt_type_enum.py
create mode 100644 test/test_property_mapping.py
create mode 100644 test/test_property_mapping_preview.py
create mode 100644 test/test_property_mapping_test_request.py
create mode 100644 test/test_property_mapping_test_result.py
create mode 100644 test/test_propertymappings_api.py
create mode 100644 test/test_protocol_enum.py
create mode 100644 test/test_provider.py
create mode 100644 test/test_provider_enum.py
create mode 100644 test/test_provider_model_enum.py
create mode 100644 test/test_provider_type_enum.py
create mode 100644 test/test_providers_api.py
create mode 100644 test/test_proxy_mode.py
create mode 100644 test/test_proxy_outpost_config.py
create mode 100644 test/test_proxy_provider.py
create mode 100644 test/test_proxy_provider_request.py
create mode 100644 test/test_rac_api.py
create mode 100644 test/test_rac_property_mapping.py
create mode 100644 test/test_rac_property_mapping_request.py
create mode 100644 test/test_rac_provider.py
create mode 100644 test/test_rac_provider_request.py
create mode 100644 test/test_radius_check_access.py
create mode 100644 test/test_radius_outpost_config.py
create mode 100644 test/test_radius_provider.py
create mode 100644 test/test_radius_provider_property_mapping.py
create mode 100644 test/test_radius_provider_property_mapping_request.py
create mode 100644 test/test_radius_provider_request.py
create mode 100644 test/test_rbac_api.py
create mode 100644 test/test_redirect_challenge.py
create mode 100644 test/test_redirect_challenge_response_request.py
create mode 100644 test/test_redirect_stage.py
create mode 100644 test/test_redirect_stage_mode_enum.py
create mode 100644 test/test_redirect_stage_request.py
create mode 100644 test/test_redirect_uri.py
create mode 100644 test/test_redirect_uri_request.py
create mode 100644 test/test_redirect_uri_type_enum.py
create mode 100644 test/test_related_group.py
create mode 100644 test/test_related_rule.py
create mode 100644 test/test_reports_api.py
create mode 100644 test/test_reputation.py
create mode 100644 test/test_reputation_policy.py
create mode 100644 test/test_reputation_policy_request.py
create mode 100644 test/test_review.py
create mode 100644 test/test_review_request.py
create mode 100644 test/test_reviewer_group.py
create mode 100644 test/test_reviewer_user.py
create mode 100644 test/test_role.py
create mode 100644 test/test_role_assigned_object_permission.py
create mode 100644 test/test_role_model_permission.py
create mode 100644 test/test_role_object_permission.py
create mode 100644 test/test_role_request.py
create mode 100644 test/test_root_api.py
create mode 100644 test/test_saml_bindings_enum.py
create mode 100644 test/test_saml_logout_methods.py
create mode 100644 test/test_saml_metadata.py
create mode 100644 test/test_saml_name_id_policy_enum.py
create mode 100644 test/test_saml_property_mapping.py
create mode 100644 test/test_saml_property_mapping_request.py
create mode 100644 test/test_saml_provider.py
create mode 100644 test/test_saml_provider_request.py
create mode 100644 test/test_saml_source.py
create mode 100644 test/test_saml_source_property_mapping.py
create mode 100644 test/test_saml_source_property_mapping_request.py
create mode 100644 test/test_saml_source_request.py
create mode 100644 test/test_schedule.py
create mode 100644 test/test_schedule_request.py
create mode 100644 test/test_schema_api.py
create mode 100644 test/test_scim_authentication_mode_enum.py
create mode 100644 test/test_scim_mapping.py
create mode 100644 test/test_scim_mapping_request.py
create mode 100644 test/test_scim_provider.py
create mode 100644 test/test_scim_provider_group.py
create mode 100644 test/test_scim_provider_group_request.py
create mode 100644 test/test_scim_provider_request.py
create mode 100644 test/test_scim_provider_user.py
create mode 100644 test/test_scim_provider_user_request.py
create mode 100644 test/test_scim_source.py
create mode 100644 test/test_scim_source_group.py
create mode 100644 test/test_scim_source_group_request.py
create mode 100644 test/test_scim_source_property_mapping.py
create mode 100644 test/test_scim_source_property_mapping_request.py
create mode 100644 test/test_scim_source_request.py
create mode 100644 test/test_scim_source_user.py
create mode 100644 test/test_scim_source_user_request.py
create mode 100644 test/test_scope_mapping.py
create mode 100644 test/test_scope_mapping_request.py
create mode 100644 test/test_selectable_stage.py
create mode 100644 test/test_service_connection.py
create mode 100644 test/test_service_connection_state.py
create mode 100644 test/test_session_end_challenge.py
create mode 100644 test/test_session_user.py
create mode 100644 test/test_settings.py
create mode 100644 test/test_settings_request.py
create mode 100644 test/test_severity_enum.py
create mode 100644 test/test_shell_challenge.py
create mode 100644 test/test_signature_algorithm_enum.py
create mode 100644 test/test_sms_device.py
create mode 100644 test/test_sms_device_request.py
create mode 100644 test/test_software.py
create mode 100644 test/test_software_request.py
create mode 100644 test/test_source.py
create mode 100644 test/test_source_stage.py
create mode 100644 test/test_source_stage_request.py
create mode 100644 test/test_source_type.py
create mode 100644 test/test_sources_api.py
create mode 100644 test/test_ssf_api.py
create mode 100644 test/test_ssf_provider.py
create mode 100644 test/test_ssf_provider_request.py
create mode 100644 test/test_ssf_stream.py
create mode 100644 test/test_ssf_stream_status_enum.py
create mode 100644 test/test_stage.py
create mode 100644 test/test_stage_mode_enum.py
create mode 100644 test/test_stage_prompt.py
create mode 100644 test/test_stages_api.py
create mode 100644 test/test_static_device.py
create mode 100644 test/test_static_device_request.py
create mode 100644 test/test_static_device_token.py
create mode 100644 test/test_sub_mode_enum.py
create mode 100644 test/test_sync_object_model_enum.py
create mode 100644 test/test_sync_object_request.py
create mode 100644 test/test_sync_object_result.py
create mode 100644 test/test_sync_outgoing_trigger_mode_enum.py
create mode 100644 test/test_sync_status.py
create mode 100644 test/test_system_info.py
create mode 100644 test/test_system_info_runtime.py
create mode 100644 test/test_task.py
create mode 100644 test/test_task_aggregated_status_enum.py
create mode 100644 test/test_task_status_enum.py
create mode 100644 test/test_tasks_api.py
create mode 100644 test/test_telegram_auth_request.py
create mode 100644 test/test_telegram_challenge_response_request.py
create mode 100644 test/test_telegram_login_challenge.py
create mode 100644 test/test_telegram_source.py
create mode 100644 test/test_telegram_source_property_mapping.py
create mode 100644 test/test_telegram_source_property_mapping_request.py
create mode 100644 test/test_telegram_source_request.py
create mode 100644 test/test_tenant.py
create mode 100644 test/test_tenant_admin_group_request_request.py
create mode 100644 test/test_tenant_recovery_key_request_request.py
create mode 100644 test/test_tenant_recovery_key_response.py
create mode 100644 test/test_tenant_request.py
create mode 100644 test/test_tenants_api.py
create mode 100644 test/test_themed_urls.py
create mode 100644 test/test_token.py
create mode 100644 test/test_token_model.py
create mode 100644 test/test_token_request.py
create mode 100644 test/test_token_set_key_request.py
create mode 100644 test/test_token_view.py
create mode 100644 test/test_totp_device.py
create mode 100644 test/test_totp_device_request.py
create mode 100644 test/test_transaction_application_request.py
create mode 100644 test/test_transaction_application_response.py
create mode 100644 test/test_transaction_policy_binding_request.py
create mode 100644 test/test_transport_mode_enum.py
create mode 100644 test/test_type_create.py
create mode 100644 test/test_ui_theme_enum.py
create mode 100644 test/test_unique_password_policy.py
create mode 100644 test/test_unique_password_policy_request.py
create mode 100644 test/test_usage_enum.py
create mode 100644 test/test_used_by.py
create mode 100644 test/test_used_by_action_enum.py
create mode 100644 test/test_user.py
create mode 100644 test/test_user_account_lockdown_request.py
create mode 100644 test/test_user_account_request.py
create mode 100644 test/test_user_account_serializer_for_role_request.py
create mode 100644 test/test_user_attribute_enum.py
create mode 100644 test/test_user_consent.py
create mode 100644 test/test_user_creation_mode_enum.py
create mode 100644 test/test_user_delete_stage.py
create mode 100644 test/test_user_delete_stage_request.py
create mode 100644 test/test_user_fields_enum.py
create mode 100644 test/test_user_kerberos_source_connection.py
create mode 100644 test/test_user_kerberos_source_connection_request.py
create mode 100644 test/test_user_ldap_source_connection.py
create mode 100644 test/test_user_ldap_source_connection_request.py
create mode 100644 test/test_user_login_challenge.py
create mode 100644 test/test_user_login_challenge_response_request.py
create mode 100644 test/test_user_login_stage.py
create mode 100644 test/test_user_login_stage_request.py
create mode 100644 test/test_user_logout_stage.py
create mode 100644 test/test_user_logout_stage_request.py
create mode 100644 test/test_user_matching_mode_enum.py
create mode 100644 test/test_user_o_auth_source_connection.py
create mode 100644 test/test_user_o_auth_source_connection_request.py
create mode 100644 test/test_user_password_hash_set_request.py
create mode 100644 test/test_user_password_set_request.py
create mode 100644 test/test_user_path.py
create mode 100644 test/test_user_plex_source_connection.py
create mode 100644 test/test_user_plex_source_connection_request.py
create mode 100644 test/test_user_recovery_email_request.py
create mode 100644 test/test_user_recovery_link_request.py
create mode 100644 test/test_user_request.py
create mode 100644 test/test_user_saml_source_connection.py
create mode 100644 test/test_user_saml_source_connection_request.py
create mode 100644 test/test_user_self.py
create mode 100644 test/test_user_self_groups.py
create mode 100644 test/test_user_self_roles.py
create mode 100644 test/test_user_service_account_request.py
create mode 100644 test/test_user_service_account_response.py
create mode 100644 test/test_user_setting.py
create mode 100644 test/test_user_source_connection.py
create mode 100644 test/test_user_source_connection_request.py
create mode 100644 test/test_user_telegram_source_connection.py
create mode 100644 test/test_user_telegram_source_connection_request.py
create mode 100644 test/test_user_type_enum.py
create mode 100644 test/test_user_verification_enum.py
create mode 100644 test/test_user_write_stage.py
create mode 100644 test/test_user_write_stage_request.py
create mode 100644 test/test_validation_error.py
create mode 100644 test/test_vendor_enum.py
create mode 100644 test/test_version.py
create mode 100644 test/test_version_history.py
create mode 100644 test/test_web_authn_device.py
create mode 100644 test/test_web_authn_device_request.py
create mode 100644 test/test_web_authn_device_type.py
create mode 100644 test/test_web_authn_hint_enum.py
create mode 100644 test/test_worker.py
create mode 100644 test/test_ws_federation_provider.py
create mode 100644 test/test_ws_federation_provider_request.py
create mode 100644 tox.ini
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 000000000..d7f079a62
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,68 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
+
+diff.test
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
new file mode 100644
index 000000000..b2fc71ca3
--- /dev/null
+++ b/.openapi-generator/FILES
@@ -0,0 +1,2746 @@
+.github/workflows/python.yml
+.gitignore
+.gitlab-ci.yml
+.travis.yml
+README.md
+authentik_client/__init__.py
+authentik_client/api/__init__.py
+authentik_client/api/admin_api.py
+authentik_client/api/authenticators_api.py
+authentik_client/api/core_api.py
+authentik_client/api/crypto_api.py
+authentik_client/api/endpoints_api.py
+authentik_client/api/enterprise_api.py
+authentik_client/api/events_api.py
+authentik_client/api/flows_api.py
+authentik_client/api/lifecycle_api.py
+authentik_client/api/managed_api.py
+authentik_client/api/oauth2_api.py
+authentik_client/api/outposts_api.py
+authentik_client/api/policies_api.py
+authentik_client/api/propertymappings_api.py
+authentik_client/api/providers_api.py
+authentik_client/api/rac_api.py
+authentik_client/api/rbac_api.py
+authentik_client/api/reports_api.py
+authentik_client/api/root_api.py
+authentik_client/api/schema_api.py
+authentik_client/api/sources_api.py
+authentik_client/api/ssf_api.py
+authentik_client/api/stages_api.py
+authentik_client/api/tasks_api.py
+authentik_client/api/tenants_api.py
+authentik_client/api_client.py
+authentik_client/api_response.py
+authentik_client/configuration.py
+authentik_client/exceptions.py
+authentik_client/models/__init__.py
+authentik_client/models/access_denied_challenge.py
+authentik_client/models/account_lockdown_stage.py
+authentik_client/models/account_lockdown_stage_request.py
+authentik_client/models/agent_authentication_response.py
+authentik_client/models/agent_config.py
+authentik_client/models/agent_connector.py
+authentik_client/models/agent_connector_request.py
+authentik_client/models/agent_psso_device_registration_request.py
+authentik_client/models/agent_psso_device_registration_response.py
+authentik_client/models/agent_psso_user_registration_request.py
+authentik_client/models/agent_token_response.py
+authentik_client/models/alg_enum.py
+authentik_client/models/app.py
+authentik_client/models/app_enum.py
+authentik_client/models/apple_challenge_response_request.py
+authentik_client/models/apple_independent_secure_enclave.py
+authentik_client/models/apple_independent_secure_enclave_request.py
+authentik_client/models/apple_login_challenge.py
+authentik_client/models/application.py
+authentik_client/models/application_entitlement.py
+authentik_client/models/application_entitlement_request.py
+authentik_client/models/application_request.py
+authentik_client/models/auth_type_enum.py
+authentik_client/models/authenticated_session.py
+authentik_client/models/authenticated_session_asn.py
+authentik_client/models/authenticated_session_geo_ip.py
+authentik_client/models/authenticated_session_user_agent.py
+authentik_client/models/authenticated_session_user_agent_device.py
+authentik_client/models/authenticated_session_user_agent_os.py
+authentik_client/models/authenticated_session_user_agent_user_agent.py
+authentik_client/models/authentication_enum.py
+authentik_client/models/authenticator_attachment_enum.py
+authentik_client/models/authenticator_duo_challenge.py
+authentik_client/models/authenticator_duo_challenge_response_request.py
+authentik_client/models/authenticator_duo_stage.py
+authentik_client/models/authenticator_duo_stage_device_import_response.py
+authentik_client/models/authenticator_duo_stage_manual_device_import_request.py
+authentik_client/models/authenticator_duo_stage_request.py
+authentik_client/models/authenticator_email_challenge.py
+authentik_client/models/authenticator_email_challenge_response_request.py
+authentik_client/models/authenticator_email_stage.py
+authentik_client/models/authenticator_email_stage_request.py
+authentik_client/models/authenticator_endpoint_gdtc_stage.py
+authentik_client/models/authenticator_endpoint_gdtc_stage_request.py
+authentik_client/models/authenticator_sms_challenge.py
+authentik_client/models/authenticator_sms_challenge_response_request.py
+authentik_client/models/authenticator_sms_stage.py
+authentik_client/models/authenticator_sms_stage_request.py
+authentik_client/models/authenticator_static_challenge.py
+authentik_client/models/authenticator_static_challenge_response_request.py
+authentik_client/models/authenticator_static_stage.py
+authentik_client/models/authenticator_static_stage_request.py
+authentik_client/models/authenticator_totp_challenge.py
+authentik_client/models/authenticator_totp_challenge_response_request.py
+authentik_client/models/authenticator_totp_stage.py
+authentik_client/models/authenticator_totp_stage_request.py
+authentik_client/models/authenticator_validate_stage.py
+authentik_client/models/authenticator_validate_stage_request.py
+authentik_client/models/authenticator_validation_challenge.py
+authentik_client/models/authenticator_validation_challenge_response_request.py
+authentik_client/models/authenticator_web_authn_challenge.py
+authentik_client/models/authenticator_web_authn_challenge_response_request.py
+authentik_client/models/authenticator_web_authn_stage.py
+authentik_client/models/authenticator_web_authn_stage_request.py
+authentik_client/models/authorization_code_auth_method_enum.py
+authentik_client/models/auto_submit_challenge_response_request.py
+authentik_client/models/autosubmit_challenge.py
+authentik_client/models/backends_enum.py
+authentik_client/models/binding_type_enum.py
+authentik_client/models/blueprint_file.py
+authentik_client/models/blueprint_import_result.py
+authentik_client/models/blueprint_instance.py
+authentik_client/models/blueprint_instance_request.py
+authentik_client/models/blueprint_instance_status_enum.py
+authentik_client/models/brand.py
+authentik_client/models/brand_request.py
+authentik_client/models/bulk_delete_session_response.py
+authentik_client/models/cache.py
+authentik_client/models/capabilities_enum.py
+authentik_client/models/captcha_challenge.py
+authentik_client/models/captcha_challenge_response_request.py
+authentik_client/models/captcha_stage.py
+authentik_client/models/captcha_stage_request.py
+authentik_client/models/cert_attribute_enum.py
+authentik_client/models/certificate_data.py
+authentik_client/models/certificate_generation_request.py
+authentik_client/models/certificate_key_pair.py
+authentik_client/models/certificate_key_pair_key_type_enum.py
+authentik_client/models/certificate_key_pair_request.py
+authentik_client/models/challenge_types.py
+authentik_client/models/client_type_enum.py
+authentik_client/models/compatibility_mode_enum.py
+authentik_client/models/config.py
+authentik_client/models/connection_token.py
+authentik_client/models/connection_token_request.py
+authentik_client/models/connector.py
+authentik_client/models/consent_challenge.py
+authentik_client/models/consent_challenge_response_request.py
+authentik_client/models/consent_mode_enum.py
+authentik_client/models/consent_permission.py
+authentik_client/models/consent_stage.py
+authentik_client/models/consent_stage_request.py
+authentik_client/models/content_type.py
+authentik_client/models/content_type_enum.py
+authentik_client/models/contextual_flow_info.py
+authentik_client/models/contextual_flow_info_layout_enum.py
+authentik_client/models/country_code_enum.py
+authentik_client/models/current_brand.py
+authentik_client/models/current_brand_flags.py
+authentik_client/models/data_export.py
+authentik_client/models/delivery_method_enum.py
+authentik_client/models/denied_action_enum.py
+authentik_client/models/deny_stage.py
+authentik_client/models/deny_stage_request.py
+authentik_client/models/detailed_country.py
+authentik_client/models/device.py
+authentik_client/models/device_access_group.py
+authentik_client/models/device_access_group_request.py
+authentik_client/models/device_challenge.py
+authentik_client/models/device_challenge_request.py
+authentik_client/models/device_classes_enum.py
+authentik_client/models/device_connection.py
+authentik_client/models/device_fact_snapshot.py
+authentik_client/models/device_facts.py
+authentik_client/models/device_facts_os_family.py
+authentik_client/models/device_facts_request.py
+authentik_client/models/device_group.py
+authentik_client/models/device_group_request.py
+authentik_client/models/device_summary.py
+authentik_client/models/device_user.py
+authentik_client/models/device_user_binding.py
+authentik_client/models/device_user_binding_request.py
+authentik_client/models/device_user_request.py
+authentik_client/models/digest_algorithm_enum.py
+authentik_client/models/digits_enum.py
+authentik_client/models/disk.py
+authentik_client/models/disk_request.py
+authentik_client/models/docker_service_connection.py
+authentik_client/models/docker_service_connection_request.py
+authentik_client/models/domain.py
+authentik_client/models/domain_request.py
+authentik_client/models/dummy_challenge.py
+authentik_client/models/dummy_challenge_response_request.py
+authentik_client/models/dummy_policy.py
+authentik_client/models/dummy_policy_request.py
+authentik_client/models/dummy_stage.py
+authentik_client/models/dummy_stage_request.py
+authentik_client/models/duo_device.py
+authentik_client/models/duo_device_enrollment_status.py
+authentik_client/models/duo_device_request.py
+authentik_client/models/duo_response_enum.py
+authentik_client/models/email_challenge.py
+authentik_client/models/email_challenge_response_request.py
+authentik_client/models/email_device.py
+authentik_client/models/email_device_request.py
+authentik_client/models/email_stage.py
+authentik_client/models/email_stage_request.py
+authentik_client/models/endpoint.py
+authentik_client/models/endpoint_agent_challenge.py
+authentik_client/models/endpoint_agent_challenge_response_request.py
+authentik_client/models/endpoint_auth_mode_enum.py
+authentik_client/models/endpoint_device.py
+authentik_client/models/endpoint_device_details.py
+authentik_client/models/endpoint_device_request.py
+authentik_client/models/endpoint_request.py
+authentik_client/models/endpoint_stage.py
+authentik_client/models/endpoint_stage_request.py
+authentik_client/models/enroll_request.py
+authentik_client/models/enrollment_token.py
+authentik_client/models/enrollment_token_request.py
+authentik_client/models/error_detail.py
+authentik_client/models/error_reporting_config.py
+authentik_client/models/event.py
+authentik_client/models/event_actions.py
+authentik_client/models/event_matcher_policy.py
+authentik_client/models/event_matcher_policy_request.py
+authentik_client/models/event_request.py
+authentik_client/models/event_stats.py
+authentik_client/models/event_top_per_user.py
+authentik_client/models/event_volume.py
+authentik_client/models/events_requested_enum.py
+authentik_client/models/expiring_base_grant_model.py
+authentik_client/models/expression_policy.py
+authentik_client/models/expression_policy_request.py
+authentik_client/models/extra_role_object_permission.py
+authentik_client/models/file_list.py
+authentik_client/models/fleet_connector.py
+authentik_client/models/fleet_connector_request.py
+authentik_client/models/flow.py
+authentik_client/models/flow_challenge_response_request.py
+authentik_client/models/flow_designation_enum.py
+authentik_client/models/flow_diagram.py
+authentik_client/models/flow_error_challenge.py
+authentik_client/models/flow_inspection.py
+authentik_client/models/flow_inspector_plan.py
+authentik_client/models/flow_layout_enum.py
+authentik_client/models/flow_request.py
+authentik_client/models/flow_set.py
+authentik_client/models/flow_stage_binding.py
+authentik_client/models/flow_stage_binding_request.py
+authentik_client/models/footer_link.py
+authentik_client/models/force_binding_enum.py
+authentik_client/models/format_enum.py
+authentik_client/models/frame_challenge.py
+authentik_client/models/frame_challenge_response_request.py
+authentik_client/models/generic_error.py
+authentik_client/models/geo_ip_policy.py
+authentik_client/models/geo_ip_policy_countries_obj_inner.py
+authentik_client/models/geo_ip_policy_request.py
+authentik_client/models/geoip_binding_enum.py
+authentik_client/models/global_task_status.py
+authentik_client/models/google_chrome_connector.py
+authentik_client/models/google_chrome_connector_request.py
+authentik_client/models/google_endpoint_device.py
+authentik_client/models/google_endpoint_device_request.py
+authentik_client/models/google_workspace_provider.py
+authentik_client/models/google_workspace_provider_group.py
+authentik_client/models/google_workspace_provider_group_request.py
+authentik_client/models/google_workspace_provider_mapping.py
+authentik_client/models/google_workspace_provider_mapping_request.py
+authentik_client/models/google_workspace_provider_request.py
+authentik_client/models/google_workspace_provider_user.py
+authentik_client/models/google_workspace_provider_user_request.py
+authentik_client/models/grant_types_enum.py
+authentik_client/models/group.py
+authentik_client/models/group_kerberos_source_connection.py
+authentik_client/models/group_kerberos_source_connection_request.py
+authentik_client/models/group_ldap_source_connection.py
+authentik_client/models/group_ldap_source_connection_request.py
+authentik_client/models/group_matching_mode_enum.py
+authentik_client/models/group_o_auth_source_connection.py
+authentik_client/models/group_o_auth_source_connection_request.py
+authentik_client/models/group_plex_source_connection.py
+authentik_client/models/group_plex_source_connection_request.py
+authentik_client/models/group_request.py
+authentik_client/models/group_saml_source_connection.py
+authentik_client/models/group_saml_source_connection_request.py
+authentik_client/models/group_source_connection.py
+authentik_client/models/group_source_connection_request.py
+authentik_client/models/group_telegram_source_connection.py
+authentik_client/models/group_telegram_source_connection_request.py
+authentik_client/models/hardware.py
+authentik_client/models/hardware_request.py
+authentik_client/models/identification_challenge.py
+authentik_client/models/identification_challenge_response_request.py
+authentik_client/models/identification_stage.py
+authentik_client/models/identification_stage_request.py
+authentik_client/models/iframe_logout_challenge.py
+authentik_client/models/iframe_logout_challenge_response_request.py
+authentik_client/models/impersonation_request.py
+authentik_client/models/initial_permissions.py
+authentik_client/models/initial_permissions_request.py
+authentik_client/models/install_id.py
+authentik_client/models/intent_enum.py
+authentik_client/models/invalid_response_action_enum.py
+authentik_client/models/invitation.py
+authentik_client/models/invitation_request.py
+authentik_client/models/invitation_send_email_request.py
+authentik_client/models/invitation_stage.py
+authentik_client/models/invitation_stage_request.py
+authentik_client/models/issuer_mode_enum.py
+authentik_client/models/kadmin_type_enum.py
+authentik_client/models/kerberos_source.py
+authentik_client/models/kerberos_source_property_mapping.py
+authentik_client/models/kerberos_source_property_mapping_request.py
+authentik_client/models/kerberos_source_request.py
+authentik_client/models/key_type_enum.py
+authentik_client/models/kubernetes_service_connection.py
+authentik_client/models/kubernetes_service_connection_request.py
+authentik_client/models/lang_enum.py
+authentik_client/models/last_task_status_enum.py
+authentik_client/models/ldap_check_access.py
+authentik_client/models/ldap_debug.py
+authentik_client/models/ldap_outpost_config.py
+authentik_client/models/ldap_provider.py
+authentik_client/models/ldap_provider_request.py
+authentik_client/models/ldap_source.py
+authentik_client/models/ldap_source_property_mapping.py
+authentik_client/models/ldap_source_property_mapping_request.py
+authentik_client/models/ldap_source_request.py
+authentik_client/models/ldapapi_access_mode.py
+authentik_client/models/license.py
+authentik_client/models/license_flags_enum.py
+authentik_client/models/license_forecast.py
+authentik_client/models/license_request.py
+authentik_client/models/license_status_enum.py
+authentik_client/models/license_summary.py
+authentik_client/models/license_summary_status_enum.py
+authentik_client/models/lifecycle_iteration.py
+authentik_client/models/lifecycle_iteration_request.py
+authentik_client/models/lifecycle_iteration_state_enum.py
+authentik_client/models/lifecycle_rule.py
+authentik_client/models/lifecycle_rule_request.py
+authentik_client/models/link.py
+authentik_client/models/log_event.py
+authentik_client/models/log_level_enum.py
+authentik_client/models/login_challenge_types.py
+authentik_client/models/login_source.py
+authentik_client/models/logout_url.py
+authentik_client/models/matching_mode_enum.py
+authentik_client/models/mdm_config_request.py
+authentik_client/models/mdm_config_response.py
+authentik_client/models/metadata.py
+authentik_client/models/microsoft_entra_provider.py
+authentik_client/models/microsoft_entra_provider_group.py
+authentik_client/models/microsoft_entra_provider_group_request.py
+authentik_client/models/microsoft_entra_provider_mapping.py
+authentik_client/models/microsoft_entra_provider_mapping_request.py
+authentik_client/models/microsoft_entra_provider_request.py
+authentik_client/models/microsoft_entra_provider_user.py
+authentik_client/models/microsoft_entra_provider_user_request.py
+authentik_client/models/model_enum.py
+authentik_client/models/model_request.py
+authentik_client/models/mutual_tls_stage.py
+authentik_client/models/mutual_tls_stage_request.py
+authentik_client/models/native_logout_challenge.py
+authentik_client/models/native_logout_challenge_response_request.py
+authentik_client/models/network.py
+authentik_client/models/network_binding_enum.py
+authentik_client/models/network_interface.py
+authentik_client/models/network_interface_request.py
+authentik_client/models/network_request.py
+authentik_client/models/not_configured_action_enum.py
+authentik_client/models/notification.py
+authentik_client/models/notification_request.py
+authentik_client/models/notification_rule.py
+authentik_client/models/notification_rule_request.py
+authentik_client/models/notification_transport.py
+authentik_client/models/notification_transport_request.py
+authentik_client/models/notification_transport_test.py
+authentik_client/models/notification_webhook_mapping.py
+authentik_client/models/notification_webhook_mapping_request.py
+authentik_client/models/o_auth2_provider.py
+authentik_client/models/o_auth2_provider_logout_method_enum.py
+authentik_client/models/o_auth2_provider_request.py
+authentik_client/models/o_auth2_provider_setup_urls.py
+authentik_client/models/o_auth_device_code_challenge.py
+authentik_client/models/o_auth_device_code_challenge_response_request.py
+authentik_client/models/o_auth_device_code_finish_challenge.py
+authentik_client/models/o_auth_device_code_finish_challenge_response_request.py
+authentik_client/models/o_auth_source.py
+authentik_client/models/o_auth_source_property_mapping.py
+authentik_client/models/o_auth_source_property_mapping_request.py
+authentik_client/models/o_auth_source_request.py
+authentik_client/models/open_id_connect_configuration.py
+authentik_client/models/operating_system.py
+authentik_client/models/operating_system_request.py
+authentik_client/models/outgoing_sync_delete_action.py
+authentik_client/models/outpost.py
+authentik_client/models/outpost_default_config.py
+authentik_client/models/outpost_health.py
+authentik_client/models/outpost_request.py
+authentik_client/models/outpost_type_enum.py
+authentik_client/models/paginated_account_lockdown_stage_list.py
+authentik_client/models/paginated_agent_connector_list.py
+authentik_client/models/paginated_apple_independent_secure_enclave_list.py
+authentik_client/models/paginated_application_entitlement_list.py
+authentik_client/models/paginated_application_list.py
+authentik_client/models/paginated_authenticated_session_list.py
+authentik_client/models/paginated_authenticator_duo_stage_list.py
+authentik_client/models/paginated_authenticator_email_stage_list.py
+authentik_client/models/paginated_authenticator_endpoint_gdtc_stage_list.py
+authentik_client/models/paginated_authenticator_sms_stage_list.py
+authentik_client/models/paginated_authenticator_static_stage_list.py
+authentik_client/models/paginated_authenticator_totp_stage_list.py
+authentik_client/models/paginated_authenticator_validate_stage_list.py
+authentik_client/models/paginated_authenticator_web_authn_stage_list.py
+authentik_client/models/paginated_blueprint_instance_list.py
+authentik_client/models/paginated_brand_list.py
+authentik_client/models/paginated_captcha_stage_list.py
+authentik_client/models/paginated_certificate_key_pair_list.py
+authentik_client/models/paginated_connection_token_list.py
+authentik_client/models/paginated_connector_list.py
+authentik_client/models/paginated_consent_stage_list.py
+authentik_client/models/paginated_data_export_list.py
+authentik_client/models/paginated_deny_stage_list.py
+authentik_client/models/paginated_device_access_group_list.py
+authentik_client/models/paginated_device_user_binding_list.py
+authentik_client/models/paginated_docker_service_connection_list.py
+authentik_client/models/paginated_domain_list.py
+authentik_client/models/paginated_dummy_policy_list.py
+authentik_client/models/paginated_dummy_stage_list.py
+authentik_client/models/paginated_duo_device_list.py
+authentik_client/models/paginated_email_device_list.py
+authentik_client/models/paginated_email_stage_list.py
+authentik_client/models/paginated_endpoint_device_list.py
+authentik_client/models/paginated_endpoint_list.py
+authentik_client/models/paginated_endpoint_stage_list.py
+authentik_client/models/paginated_enrollment_token_list.py
+authentik_client/models/paginated_event_list.py
+authentik_client/models/paginated_event_matcher_policy_list.py
+authentik_client/models/paginated_expiring_base_grant_model_list.py
+authentik_client/models/paginated_expression_policy_list.py
+authentik_client/models/paginated_extra_role_object_permission_list.py
+authentik_client/models/paginated_fleet_connector_list.py
+authentik_client/models/paginated_flow_list.py
+authentik_client/models/paginated_flow_stage_binding_list.py
+authentik_client/models/paginated_geo_ip_policy_list.py
+authentik_client/models/paginated_google_chrome_connector_list.py
+authentik_client/models/paginated_google_endpoint_device_list.py
+authentik_client/models/paginated_google_workspace_provider_group_list.py
+authentik_client/models/paginated_google_workspace_provider_list.py
+authentik_client/models/paginated_google_workspace_provider_mapping_list.py
+authentik_client/models/paginated_google_workspace_provider_user_list.py
+authentik_client/models/paginated_group_kerberos_source_connection_list.py
+authentik_client/models/paginated_group_ldap_source_connection_list.py
+authentik_client/models/paginated_group_list.py
+authentik_client/models/paginated_group_o_auth_source_connection_list.py
+authentik_client/models/paginated_group_plex_source_connection_list.py
+authentik_client/models/paginated_group_saml_source_connection_list.py
+authentik_client/models/paginated_group_source_connection_list.py
+authentik_client/models/paginated_group_telegram_source_connection_list.py
+authentik_client/models/paginated_identification_stage_list.py
+authentik_client/models/paginated_initial_permissions_list.py
+authentik_client/models/paginated_invitation_list.py
+authentik_client/models/paginated_invitation_stage_list.py
+authentik_client/models/paginated_kerberos_source_list.py
+authentik_client/models/paginated_kerberos_source_property_mapping_list.py
+authentik_client/models/paginated_kubernetes_service_connection_list.py
+authentik_client/models/paginated_ldap_outpost_config_list.py
+authentik_client/models/paginated_ldap_provider_list.py
+authentik_client/models/paginated_ldap_source_list.py
+authentik_client/models/paginated_ldap_source_property_mapping_list.py
+authentik_client/models/paginated_license_list.py
+authentik_client/models/paginated_lifecycle_iteration_list.py
+authentik_client/models/paginated_lifecycle_rule_list.py
+authentik_client/models/paginated_microsoft_entra_provider_group_list.py
+authentik_client/models/paginated_microsoft_entra_provider_list.py
+authentik_client/models/paginated_microsoft_entra_provider_mapping_list.py
+authentik_client/models/paginated_microsoft_entra_provider_user_list.py
+authentik_client/models/paginated_mutual_tls_stage_list.py
+authentik_client/models/paginated_notification_list.py
+authentik_client/models/paginated_notification_rule_list.py
+authentik_client/models/paginated_notification_transport_list.py
+authentik_client/models/paginated_notification_webhook_mapping_list.py
+authentik_client/models/paginated_o_auth2_provider_list.py
+authentik_client/models/paginated_o_auth_source_list.py
+authentik_client/models/paginated_o_auth_source_property_mapping_list.py
+authentik_client/models/paginated_outpost_list.py
+authentik_client/models/paginated_password_expiry_policy_list.py
+authentik_client/models/paginated_password_policy_list.py
+authentik_client/models/paginated_password_stage_list.py
+authentik_client/models/paginated_permission_list.py
+authentik_client/models/paginated_plex_source_list.py
+authentik_client/models/paginated_plex_source_property_mapping_list.py
+authentik_client/models/paginated_policy_binding_list.py
+authentik_client/models/paginated_policy_list.py
+authentik_client/models/paginated_prompt_list.py
+authentik_client/models/paginated_prompt_stage_list.py
+authentik_client/models/paginated_property_mapping_list.py
+authentik_client/models/paginated_provider_list.py
+authentik_client/models/paginated_proxy_outpost_config_list.py
+authentik_client/models/paginated_proxy_provider_list.py
+authentik_client/models/paginated_rac_property_mapping_list.py
+authentik_client/models/paginated_rac_provider_list.py
+authentik_client/models/paginated_radius_outpost_config_list.py
+authentik_client/models/paginated_radius_provider_list.py
+authentik_client/models/paginated_radius_provider_property_mapping_list.py
+authentik_client/models/paginated_redirect_stage_list.py
+authentik_client/models/paginated_reputation_list.py
+authentik_client/models/paginated_reputation_policy_list.py
+authentik_client/models/paginated_role_assigned_object_permission_list.py
+authentik_client/models/paginated_role_list.py
+authentik_client/models/paginated_saml_property_mapping_list.py
+authentik_client/models/paginated_saml_provider_list.py
+authentik_client/models/paginated_saml_source_list.py
+authentik_client/models/paginated_saml_source_property_mapping_list.py
+authentik_client/models/paginated_schedule_list.py
+authentik_client/models/paginated_scim_mapping_list.py
+authentik_client/models/paginated_scim_provider_group_list.py
+authentik_client/models/paginated_scim_provider_list.py
+authentik_client/models/paginated_scim_provider_user_list.py
+authentik_client/models/paginated_scim_source_group_list.py
+authentik_client/models/paginated_scim_source_list.py
+authentik_client/models/paginated_scim_source_property_mapping_list.py
+authentik_client/models/paginated_scim_source_user_list.py
+authentik_client/models/paginated_scope_mapping_list.py
+authentik_client/models/paginated_service_connection_list.py
+authentik_client/models/paginated_sms_device_list.py
+authentik_client/models/paginated_source_list.py
+authentik_client/models/paginated_source_stage_list.py
+authentik_client/models/paginated_ssf_provider_list.py
+authentik_client/models/paginated_ssf_stream_list.py
+authentik_client/models/paginated_stage_list.py
+authentik_client/models/paginated_static_device_list.py
+authentik_client/models/paginated_task_list.py
+authentik_client/models/paginated_telegram_source_list.py
+authentik_client/models/paginated_telegram_source_property_mapping_list.py
+authentik_client/models/paginated_tenant_list.py
+authentik_client/models/paginated_token_list.py
+authentik_client/models/paginated_token_model_list.py
+authentik_client/models/paginated_totp_device_list.py
+authentik_client/models/paginated_unique_password_policy_list.py
+authentik_client/models/paginated_user_consent_list.py
+authentik_client/models/paginated_user_delete_stage_list.py
+authentik_client/models/paginated_user_kerberos_source_connection_list.py
+authentik_client/models/paginated_user_ldap_source_connection_list.py
+authentik_client/models/paginated_user_list.py
+authentik_client/models/paginated_user_login_stage_list.py
+authentik_client/models/paginated_user_logout_stage_list.py
+authentik_client/models/paginated_user_o_auth_source_connection_list.py
+authentik_client/models/paginated_user_plex_source_connection_list.py
+authentik_client/models/paginated_user_saml_source_connection_list.py
+authentik_client/models/paginated_user_source_connection_list.py
+authentik_client/models/paginated_user_telegram_source_connection_list.py
+authentik_client/models/paginated_user_write_stage_list.py
+authentik_client/models/paginated_web_authn_device_list.py
+authentik_client/models/paginated_web_authn_device_type_list.py
+authentik_client/models/paginated_ws_federation_provider_list.py
+authentik_client/models/pagination.py
+authentik_client/models/partial_group.py
+authentik_client/models/partial_user.py
+authentik_client/models/password_challenge.py
+authentik_client/models/password_challenge_response_request.py
+authentik_client/models/password_expiry_policy.py
+authentik_client/models/password_expiry_policy_request.py
+authentik_client/models/password_policy.py
+authentik_client/models/password_policy_request.py
+authentik_client/models/password_stage.py
+authentik_client/models/password_stage_request.py
+authentik_client/models/patched_account_lockdown_stage_request.py
+authentik_client/models/patched_agent_connector_request.py
+authentik_client/models/patched_apple_independent_secure_enclave_request.py
+authentik_client/models/patched_application_entitlement_request.py
+authentik_client/models/patched_application_request.py
+authentik_client/models/patched_authenticator_duo_stage_request.py
+authentik_client/models/patched_authenticator_email_stage_request.py
+authentik_client/models/patched_authenticator_endpoint_gdtc_stage_request.py
+authentik_client/models/patched_authenticator_sms_stage_request.py
+authentik_client/models/patched_authenticator_static_stage_request.py
+authentik_client/models/patched_authenticator_totp_stage_request.py
+authentik_client/models/patched_authenticator_validate_stage_request.py
+authentik_client/models/patched_authenticator_web_authn_stage_request.py
+authentik_client/models/patched_blueprint_instance_request.py
+authentik_client/models/patched_brand_request.py
+authentik_client/models/patched_captcha_stage_request.py
+authentik_client/models/patched_certificate_key_pair_request.py
+authentik_client/models/patched_connection_token_request.py
+authentik_client/models/patched_consent_stage_request.py
+authentik_client/models/patched_deny_stage_request.py
+authentik_client/models/patched_device_access_group_request.py
+authentik_client/models/patched_device_user_binding_request.py
+authentik_client/models/patched_docker_service_connection_request.py
+authentik_client/models/patched_domain_request.py
+authentik_client/models/patched_dummy_policy_request.py
+authentik_client/models/patched_dummy_stage_request.py
+authentik_client/models/patched_duo_device_request.py
+authentik_client/models/patched_email_device_request.py
+authentik_client/models/patched_email_stage_request.py
+authentik_client/models/patched_endpoint_device_request.py
+authentik_client/models/patched_endpoint_request.py
+authentik_client/models/patched_endpoint_stage_request.py
+authentik_client/models/patched_enrollment_token_request.py
+authentik_client/models/patched_event_matcher_policy_request.py
+authentik_client/models/patched_event_request.py
+authentik_client/models/patched_expression_policy_request.py
+authentik_client/models/patched_fleet_connector_request.py
+authentik_client/models/patched_flow_request.py
+authentik_client/models/patched_flow_stage_binding_request.py
+authentik_client/models/patched_geo_ip_policy_request.py
+authentik_client/models/patched_google_chrome_connector_request.py
+authentik_client/models/patched_google_endpoint_device_request.py
+authentik_client/models/patched_google_workspace_provider_mapping_request.py
+authentik_client/models/patched_google_workspace_provider_request.py
+authentik_client/models/patched_group_kerberos_source_connection_request.py
+authentik_client/models/patched_group_ldap_source_connection_request.py
+authentik_client/models/patched_group_o_auth_source_connection_request.py
+authentik_client/models/patched_group_plex_source_connection_request.py
+authentik_client/models/patched_group_request.py
+authentik_client/models/patched_group_saml_source_connection_request.py
+authentik_client/models/patched_group_source_connection_request.py
+authentik_client/models/patched_group_telegram_source_connection_request.py
+authentik_client/models/patched_identification_stage_request.py
+authentik_client/models/patched_initial_permissions_request.py
+authentik_client/models/patched_invitation_request.py
+authentik_client/models/patched_invitation_stage_request.py
+authentik_client/models/patched_kerberos_source_property_mapping_request.py
+authentik_client/models/patched_kerberos_source_request.py
+authentik_client/models/patched_kubernetes_service_connection_request.py
+authentik_client/models/patched_ldap_provider_request.py
+authentik_client/models/patched_ldap_source_property_mapping_request.py
+authentik_client/models/patched_ldap_source_request.py
+authentik_client/models/patched_license_request.py
+authentik_client/models/patched_lifecycle_rule_request.py
+authentik_client/models/patched_microsoft_entra_provider_mapping_request.py
+authentik_client/models/patched_microsoft_entra_provider_request.py
+authentik_client/models/patched_mutual_tls_stage_request.py
+authentik_client/models/patched_notification_request.py
+authentik_client/models/patched_notification_rule_request.py
+authentik_client/models/patched_notification_transport_request.py
+authentik_client/models/patched_notification_webhook_mapping_request.py
+authentik_client/models/patched_o_auth2_provider_request.py
+authentik_client/models/patched_o_auth_source_property_mapping_request.py
+authentik_client/models/patched_o_auth_source_request.py
+authentik_client/models/patched_outpost_request.py
+authentik_client/models/patched_password_expiry_policy_request.py
+authentik_client/models/patched_password_policy_request.py
+authentik_client/models/patched_password_stage_request.py
+authentik_client/models/patched_permission_assign_request.py
+authentik_client/models/patched_plex_source_property_mapping_request.py
+authentik_client/models/patched_plex_source_request.py
+authentik_client/models/patched_policy_binding_request.py
+authentik_client/models/patched_prompt_request.py
+authentik_client/models/patched_prompt_stage_request.py
+authentik_client/models/patched_proxy_provider_request.py
+authentik_client/models/patched_rac_property_mapping_request.py
+authentik_client/models/patched_rac_provider_request.py
+authentik_client/models/patched_radius_provider_property_mapping_request.py
+authentik_client/models/patched_radius_provider_request.py
+authentik_client/models/patched_redirect_stage_request.py
+authentik_client/models/patched_reputation_policy_request.py
+authentik_client/models/patched_role_request.py
+authentik_client/models/patched_saml_property_mapping_request.py
+authentik_client/models/patched_saml_provider_request.py
+authentik_client/models/patched_saml_source_property_mapping_request.py
+authentik_client/models/patched_saml_source_request.py
+authentik_client/models/patched_schedule_request.py
+authentik_client/models/patched_scim_mapping_request.py
+authentik_client/models/patched_scim_provider_request.py
+authentik_client/models/patched_scim_source_group_request.py
+authentik_client/models/patched_scim_source_property_mapping_request.py
+authentik_client/models/patched_scim_source_request.py
+authentik_client/models/patched_scim_source_user_request.py
+authentik_client/models/patched_scope_mapping_request.py
+authentik_client/models/patched_settings_request.py
+authentik_client/models/patched_settings_request_flags.py
+authentik_client/models/patched_sms_device_request.py
+authentik_client/models/patched_source_stage_request.py
+authentik_client/models/patched_ssf_provider_request.py
+authentik_client/models/patched_static_device_request.py
+authentik_client/models/patched_telegram_source_property_mapping_request.py
+authentik_client/models/patched_telegram_source_request.py
+authentik_client/models/patched_tenant_request.py
+authentik_client/models/patched_token_request.py
+authentik_client/models/patched_totp_device_request.py
+authentik_client/models/patched_unique_password_policy_request.py
+authentik_client/models/patched_user_delete_stage_request.py
+authentik_client/models/patched_user_kerberos_source_connection_request.py
+authentik_client/models/patched_user_ldap_source_connection_request.py
+authentik_client/models/patched_user_login_stage_request.py
+authentik_client/models/patched_user_logout_stage_request.py
+authentik_client/models/patched_user_o_auth_source_connection_request.py
+authentik_client/models/patched_user_plex_source_connection_request.py
+authentik_client/models/patched_user_request.py
+authentik_client/models/patched_user_saml_source_connection_request.py
+authentik_client/models/patched_user_source_connection_request.py
+authentik_client/models/patched_user_telegram_source_connection_request.py
+authentik_client/models/patched_user_write_stage_request.py
+authentik_client/models/patched_web_authn_device_request.py
+authentik_client/models/patched_ws_federation_provider_request.py
+authentik_client/models/permission.py
+authentik_client/models/permission_assign_request.py
+authentik_client/models/permission_assign_result.py
+authentik_client/models/pkce_method_enum.py
+authentik_client/models/plex_authentication_challenge.py
+authentik_client/models/plex_authentication_challenge_response_request.py
+authentik_client/models/plex_source.py
+authentik_client/models/plex_source_property_mapping.py
+authentik_client/models/plex_source_property_mapping_request.py
+authentik_client/models/plex_source_request.py
+authentik_client/models/plex_token_redeem_request.py
+authentik_client/models/policy.py
+authentik_client/models/policy_binding.py
+authentik_client/models/policy_binding_request.py
+authentik_client/models/policy_engine_mode.py
+authentik_client/models/policy_test_request.py
+authentik_client/models/policy_test_result.py
+authentik_client/models/process.py
+authentik_client/models/process_request.py
+authentik_client/models/prompt.py
+authentik_client/models/prompt_challenge.py
+authentik_client/models/prompt_challenge_response_request.py
+authentik_client/models/prompt_choice.py
+authentik_client/models/prompt_request.py
+authentik_client/models/prompt_stage.py
+authentik_client/models/prompt_stage_request.py
+authentik_client/models/prompt_type_enum.py
+authentik_client/models/property_mapping.py
+authentik_client/models/property_mapping_preview.py
+authentik_client/models/property_mapping_test_request.py
+authentik_client/models/property_mapping_test_result.py
+authentik_client/models/protocol_enum.py
+authentik_client/models/provider.py
+authentik_client/models/provider_enum.py
+authentik_client/models/provider_model_enum.py
+authentik_client/models/provider_type_enum.py
+authentik_client/models/proxy_mode.py
+authentik_client/models/proxy_outpost_config.py
+authentik_client/models/proxy_provider.py
+authentik_client/models/proxy_provider_request.py
+authentik_client/models/rac_property_mapping.py
+authentik_client/models/rac_property_mapping_request.py
+authentik_client/models/rac_provider.py
+authentik_client/models/rac_provider_request.py
+authentik_client/models/radius_check_access.py
+authentik_client/models/radius_outpost_config.py
+authentik_client/models/radius_provider.py
+authentik_client/models/radius_provider_property_mapping.py
+authentik_client/models/radius_provider_property_mapping_request.py
+authentik_client/models/radius_provider_request.py
+authentik_client/models/redirect_challenge.py
+authentik_client/models/redirect_challenge_response_request.py
+authentik_client/models/redirect_stage.py
+authentik_client/models/redirect_stage_mode_enum.py
+authentik_client/models/redirect_stage_request.py
+authentik_client/models/redirect_uri.py
+authentik_client/models/redirect_uri_request.py
+authentik_client/models/redirect_uri_type_enum.py
+authentik_client/models/related_group.py
+authentik_client/models/related_rule.py
+authentik_client/models/reputation.py
+authentik_client/models/reputation_policy.py
+authentik_client/models/reputation_policy_request.py
+authentik_client/models/review.py
+authentik_client/models/review_request.py
+authentik_client/models/reviewer_group.py
+authentik_client/models/reviewer_user.py
+authentik_client/models/role.py
+authentik_client/models/role_assigned_object_permission.py
+authentik_client/models/role_model_permission.py
+authentik_client/models/role_object_permission.py
+authentik_client/models/role_request.py
+authentik_client/models/saml_bindings_enum.py
+authentik_client/models/saml_logout_methods.py
+authentik_client/models/saml_metadata.py
+authentik_client/models/saml_name_id_policy_enum.py
+authentik_client/models/saml_property_mapping.py
+authentik_client/models/saml_property_mapping_request.py
+authentik_client/models/saml_provider.py
+authentik_client/models/saml_provider_request.py
+authentik_client/models/saml_source.py
+authentik_client/models/saml_source_property_mapping.py
+authentik_client/models/saml_source_property_mapping_request.py
+authentik_client/models/saml_source_request.py
+authentik_client/models/schedule.py
+authentik_client/models/schedule_request.py
+authentik_client/models/scim_authentication_mode_enum.py
+authentik_client/models/scim_mapping.py
+authentik_client/models/scim_mapping_request.py
+authentik_client/models/scim_provider.py
+authentik_client/models/scim_provider_group.py
+authentik_client/models/scim_provider_group_request.py
+authentik_client/models/scim_provider_request.py
+authentik_client/models/scim_provider_user.py
+authentik_client/models/scim_provider_user_request.py
+authentik_client/models/scim_source.py
+authentik_client/models/scim_source_group.py
+authentik_client/models/scim_source_group_request.py
+authentik_client/models/scim_source_property_mapping.py
+authentik_client/models/scim_source_property_mapping_request.py
+authentik_client/models/scim_source_request.py
+authentik_client/models/scim_source_user.py
+authentik_client/models/scim_source_user_request.py
+authentik_client/models/scope_mapping.py
+authentik_client/models/scope_mapping_request.py
+authentik_client/models/selectable_stage.py
+authentik_client/models/service_connection.py
+authentik_client/models/service_connection_state.py
+authentik_client/models/session_end_challenge.py
+authentik_client/models/session_user.py
+authentik_client/models/settings.py
+authentik_client/models/settings_request.py
+authentik_client/models/severity_enum.py
+authentik_client/models/shell_challenge.py
+authentik_client/models/signature_algorithm_enum.py
+authentik_client/models/sms_device.py
+authentik_client/models/sms_device_request.py
+authentik_client/models/software.py
+authentik_client/models/software_request.py
+authentik_client/models/source.py
+authentik_client/models/source_stage.py
+authentik_client/models/source_stage_request.py
+authentik_client/models/source_type.py
+authentik_client/models/ssf_provider.py
+authentik_client/models/ssf_provider_request.py
+authentik_client/models/ssf_stream.py
+authentik_client/models/ssf_stream_status_enum.py
+authentik_client/models/stage.py
+authentik_client/models/stage_mode_enum.py
+authentik_client/models/stage_prompt.py
+authentik_client/models/static_device.py
+authentik_client/models/static_device_request.py
+authentik_client/models/static_device_token.py
+authentik_client/models/sub_mode_enum.py
+authentik_client/models/sync_object_model_enum.py
+authentik_client/models/sync_object_request.py
+authentik_client/models/sync_object_result.py
+authentik_client/models/sync_outgoing_trigger_mode_enum.py
+authentik_client/models/sync_status.py
+authentik_client/models/system_info.py
+authentik_client/models/system_info_runtime.py
+authentik_client/models/task.py
+authentik_client/models/task_aggregated_status_enum.py
+authentik_client/models/task_status_enum.py
+authentik_client/models/telegram_auth_request.py
+authentik_client/models/telegram_challenge_response_request.py
+authentik_client/models/telegram_login_challenge.py
+authentik_client/models/telegram_source.py
+authentik_client/models/telegram_source_property_mapping.py
+authentik_client/models/telegram_source_property_mapping_request.py
+authentik_client/models/telegram_source_request.py
+authentik_client/models/tenant.py
+authentik_client/models/tenant_admin_group_request_request.py
+authentik_client/models/tenant_recovery_key_request_request.py
+authentik_client/models/tenant_recovery_key_response.py
+authentik_client/models/tenant_request.py
+authentik_client/models/themed_urls.py
+authentik_client/models/token.py
+authentik_client/models/token_model.py
+authentik_client/models/token_request.py
+authentik_client/models/token_set_key_request.py
+authentik_client/models/token_view.py
+authentik_client/models/totp_device.py
+authentik_client/models/totp_device_request.py
+authentik_client/models/transaction_application_request.py
+authentik_client/models/transaction_application_response.py
+authentik_client/models/transaction_policy_binding_request.py
+authentik_client/models/transport_mode_enum.py
+authentik_client/models/type_create.py
+authentik_client/models/ui_theme_enum.py
+authentik_client/models/unique_password_policy.py
+authentik_client/models/unique_password_policy_request.py
+authentik_client/models/usage_enum.py
+authentik_client/models/used_by.py
+authentik_client/models/used_by_action_enum.py
+authentik_client/models/user.py
+authentik_client/models/user_account_lockdown_request.py
+authentik_client/models/user_account_request.py
+authentik_client/models/user_account_serializer_for_role_request.py
+authentik_client/models/user_attribute_enum.py
+authentik_client/models/user_consent.py
+authentik_client/models/user_creation_mode_enum.py
+authentik_client/models/user_delete_stage.py
+authentik_client/models/user_delete_stage_request.py
+authentik_client/models/user_fields_enum.py
+authentik_client/models/user_kerberos_source_connection.py
+authentik_client/models/user_kerberos_source_connection_request.py
+authentik_client/models/user_ldap_source_connection.py
+authentik_client/models/user_ldap_source_connection_request.py
+authentik_client/models/user_login_challenge.py
+authentik_client/models/user_login_challenge_response_request.py
+authentik_client/models/user_login_stage.py
+authentik_client/models/user_login_stage_request.py
+authentik_client/models/user_logout_stage.py
+authentik_client/models/user_logout_stage_request.py
+authentik_client/models/user_matching_mode_enum.py
+authentik_client/models/user_o_auth_source_connection.py
+authentik_client/models/user_o_auth_source_connection_request.py
+authentik_client/models/user_password_hash_set_request.py
+authentik_client/models/user_password_set_request.py
+authentik_client/models/user_path.py
+authentik_client/models/user_plex_source_connection.py
+authentik_client/models/user_plex_source_connection_request.py
+authentik_client/models/user_recovery_email_request.py
+authentik_client/models/user_recovery_link_request.py
+authentik_client/models/user_request.py
+authentik_client/models/user_saml_source_connection.py
+authentik_client/models/user_saml_source_connection_request.py
+authentik_client/models/user_self.py
+authentik_client/models/user_self_groups.py
+authentik_client/models/user_self_roles.py
+authentik_client/models/user_service_account_request.py
+authentik_client/models/user_service_account_response.py
+authentik_client/models/user_setting.py
+authentik_client/models/user_source_connection.py
+authentik_client/models/user_source_connection_request.py
+authentik_client/models/user_telegram_source_connection.py
+authentik_client/models/user_telegram_source_connection_request.py
+authentik_client/models/user_type_enum.py
+authentik_client/models/user_verification_enum.py
+authentik_client/models/user_write_stage.py
+authentik_client/models/user_write_stage_request.py
+authentik_client/models/validation_error.py
+authentik_client/models/vendor_enum.py
+authentik_client/models/version.py
+authentik_client/models/version_history.py
+authentik_client/models/web_authn_device.py
+authentik_client/models/web_authn_device_request.py
+authentik_client/models/web_authn_device_type.py
+authentik_client/models/web_authn_hint_enum.py
+authentik_client/models/worker.py
+authentik_client/models/ws_federation_provider.py
+authentik_client/models/ws_federation_provider_request.py
+authentik_client/py.typed
+authentik_client/rest.py
+docs/AccessDeniedChallenge.md
+docs/AccountLockdownStage.md
+docs/AccountLockdownStageRequest.md
+docs/AdminApi.md
+docs/AgentAuthenticationResponse.md
+docs/AgentConfig.md
+docs/AgentConnector.md
+docs/AgentConnectorRequest.md
+docs/AgentPSSODeviceRegistrationRequest.md
+docs/AgentPSSODeviceRegistrationResponse.md
+docs/AgentPSSOUserRegistrationRequest.md
+docs/AgentTokenResponse.md
+docs/AlgEnum.md
+docs/App.md
+docs/AppEnum.md
+docs/AppleChallengeResponseRequest.md
+docs/AppleIndependentSecureEnclave.md
+docs/AppleIndependentSecureEnclaveRequest.md
+docs/AppleLoginChallenge.md
+docs/Application.md
+docs/ApplicationEntitlement.md
+docs/ApplicationEntitlementRequest.md
+docs/ApplicationRequest.md
+docs/AuthTypeEnum.md
+docs/AuthenticatedSession.md
+docs/AuthenticatedSessionAsn.md
+docs/AuthenticatedSessionGeoIp.md
+docs/AuthenticatedSessionUserAgent.md
+docs/AuthenticatedSessionUserAgentDevice.md
+docs/AuthenticatedSessionUserAgentOs.md
+docs/AuthenticatedSessionUserAgentUserAgent.md
+docs/AuthenticationEnum.md
+docs/AuthenticatorAttachmentEnum.md
+docs/AuthenticatorDuoChallenge.md
+docs/AuthenticatorDuoChallengeResponseRequest.md
+docs/AuthenticatorDuoStage.md
+docs/AuthenticatorDuoStageDeviceImportResponse.md
+docs/AuthenticatorDuoStageManualDeviceImportRequest.md
+docs/AuthenticatorDuoStageRequest.md
+docs/AuthenticatorEmailChallenge.md
+docs/AuthenticatorEmailChallengeResponseRequest.md
+docs/AuthenticatorEmailStage.md
+docs/AuthenticatorEmailStageRequest.md
+docs/AuthenticatorEndpointGDTCStage.md
+docs/AuthenticatorEndpointGDTCStageRequest.md
+docs/AuthenticatorSMSChallenge.md
+docs/AuthenticatorSMSChallengeResponseRequest.md
+docs/AuthenticatorSMSStage.md
+docs/AuthenticatorSMSStageRequest.md
+docs/AuthenticatorStaticChallenge.md
+docs/AuthenticatorStaticChallengeResponseRequest.md
+docs/AuthenticatorStaticStage.md
+docs/AuthenticatorStaticStageRequest.md
+docs/AuthenticatorTOTPChallenge.md
+docs/AuthenticatorTOTPChallengeResponseRequest.md
+docs/AuthenticatorTOTPStage.md
+docs/AuthenticatorTOTPStageRequest.md
+docs/AuthenticatorValidateStage.md
+docs/AuthenticatorValidateStageRequest.md
+docs/AuthenticatorValidationChallenge.md
+docs/AuthenticatorValidationChallengeResponseRequest.md
+docs/AuthenticatorWebAuthnChallenge.md
+docs/AuthenticatorWebAuthnChallengeResponseRequest.md
+docs/AuthenticatorWebAuthnStage.md
+docs/AuthenticatorWebAuthnStageRequest.md
+docs/AuthenticatorsApi.md
+docs/AuthorizationCodeAuthMethodEnum.md
+docs/AutoSubmitChallengeResponseRequest.md
+docs/AutosubmitChallenge.md
+docs/BackendsEnum.md
+docs/BindingTypeEnum.md
+docs/BlueprintFile.md
+docs/BlueprintImportResult.md
+docs/BlueprintInstance.md
+docs/BlueprintInstanceRequest.md
+docs/BlueprintInstanceStatusEnum.md
+docs/Brand.md
+docs/BrandRequest.md
+docs/BulkDeleteSessionResponse.md
+docs/Cache.md
+docs/CapabilitiesEnum.md
+docs/CaptchaChallenge.md
+docs/CaptchaChallengeResponseRequest.md
+docs/CaptchaStage.md
+docs/CaptchaStageRequest.md
+docs/CertAttributeEnum.md
+docs/CertificateData.md
+docs/CertificateGenerationRequest.md
+docs/CertificateKeyPair.md
+docs/CertificateKeyPairKeyTypeEnum.md
+docs/CertificateKeyPairRequest.md
+docs/ChallengeTypes.md
+docs/ClientTypeEnum.md
+docs/CompatibilityModeEnum.md
+docs/Config.md
+docs/ConnectionToken.md
+docs/ConnectionTokenRequest.md
+docs/Connector.md
+docs/ConsentChallenge.md
+docs/ConsentChallengeResponseRequest.md
+docs/ConsentModeEnum.md
+docs/ConsentPermission.md
+docs/ConsentStage.md
+docs/ConsentStageRequest.md
+docs/ContentType.md
+docs/ContentTypeEnum.md
+docs/ContextualFlowInfo.md
+docs/ContextualFlowInfoLayoutEnum.md
+docs/CoreApi.md
+docs/CountryCodeEnum.md
+docs/CryptoApi.md
+docs/CurrentBrand.md
+docs/CurrentBrandFlags.md
+docs/DataExport.md
+docs/DeliveryMethodEnum.md
+docs/DeniedActionEnum.md
+docs/DenyStage.md
+docs/DenyStageRequest.md
+docs/DetailedCountry.md
+docs/Device.md
+docs/DeviceAccessGroup.md
+docs/DeviceAccessGroupRequest.md
+docs/DeviceChallenge.md
+docs/DeviceChallengeRequest.md
+docs/DeviceClassesEnum.md
+docs/DeviceConnection.md
+docs/DeviceFactSnapshot.md
+docs/DeviceFacts.md
+docs/DeviceFactsOSFamily.md
+docs/DeviceFactsRequest.md
+docs/DeviceGroup.md
+docs/DeviceGroupRequest.md
+docs/DeviceSummary.md
+docs/DeviceUser.md
+docs/DeviceUserBinding.md
+docs/DeviceUserBindingRequest.md
+docs/DeviceUserRequest.md
+docs/DigestAlgorithmEnum.md
+docs/DigitsEnum.md
+docs/Disk.md
+docs/DiskRequest.md
+docs/DockerServiceConnection.md
+docs/DockerServiceConnectionRequest.md
+docs/Domain.md
+docs/DomainRequest.md
+docs/DummyChallenge.md
+docs/DummyChallengeResponseRequest.md
+docs/DummyPolicy.md
+docs/DummyPolicyRequest.md
+docs/DummyStage.md
+docs/DummyStageRequest.md
+docs/DuoDevice.md
+docs/DuoDeviceEnrollmentStatus.md
+docs/DuoDeviceRequest.md
+docs/DuoResponseEnum.md
+docs/EmailChallenge.md
+docs/EmailChallengeResponseRequest.md
+docs/EmailDevice.md
+docs/EmailDeviceRequest.md
+docs/EmailStage.md
+docs/EmailStageRequest.md
+docs/Endpoint.md
+docs/EndpointAgentChallenge.md
+docs/EndpointAgentChallengeResponseRequest.md
+docs/EndpointAuthModeEnum.md
+docs/EndpointDevice.md
+docs/EndpointDeviceDetails.md
+docs/EndpointDeviceRequest.md
+docs/EndpointRequest.md
+docs/EndpointStage.md
+docs/EndpointStageRequest.md
+docs/EndpointsApi.md
+docs/EnrollRequest.md
+docs/EnrollmentToken.md
+docs/EnrollmentTokenRequest.md
+docs/EnterpriseApi.md
+docs/ErrorDetail.md
+docs/ErrorReportingConfig.md
+docs/Event.md
+docs/EventActions.md
+docs/EventMatcherPolicy.md
+docs/EventMatcherPolicyRequest.md
+docs/EventRequest.md
+docs/EventStats.md
+docs/EventTopPerUser.md
+docs/EventVolume.md
+docs/EventsApi.md
+docs/EventsRequestedEnum.md
+docs/ExpiringBaseGrantModel.md
+docs/ExpressionPolicy.md
+docs/ExpressionPolicyRequest.md
+docs/ExtraRoleObjectPermission.md
+docs/FileList.md
+docs/FleetConnector.md
+docs/FleetConnectorRequest.md
+docs/Flow.md
+docs/FlowChallengeResponseRequest.md
+docs/FlowDesignationEnum.md
+docs/FlowDiagram.md
+docs/FlowErrorChallenge.md
+docs/FlowInspection.md
+docs/FlowInspectorPlan.md
+docs/FlowLayoutEnum.md
+docs/FlowRequest.md
+docs/FlowSet.md
+docs/FlowStageBinding.md
+docs/FlowStageBindingRequest.md
+docs/FlowsApi.md
+docs/FooterLink.md
+docs/ForceBindingEnum.md
+docs/FormatEnum.md
+docs/FrameChallenge.md
+docs/FrameChallengeResponseRequest.md
+docs/GenericError.md
+docs/GeoIPPolicy.md
+docs/GeoIPPolicyCountriesObjInner.md
+docs/GeoIPPolicyRequest.md
+docs/GeoipBindingEnum.md
+docs/GlobalTaskStatus.md
+docs/GoogleChromeConnector.md
+docs/GoogleChromeConnectorRequest.md
+docs/GoogleEndpointDevice.md
+docs/GoogleEndpointDeviceRequest.md
+docs/GoogleWorkspaceProvider.md
+docs/GoogleWorkspaceProviderGroup.md
+docs/GoogleWorkspaceProviderGroupRequest.md
+docs/GoogleWorkspaceProviderMapping.md
+docs/GoogleWorkspaceProviderMappingRequest.md
+docs/GoogleWorkspaceProviderRequest.md
+docs/GoogleWorkspaceProviderUser.md
+docs/GoogleWorkspaceProviderUserRequest.md
+docs/GrantTypesEnum.md
+docs/Group.md
+docs/GroupKerberosSourceConnection.md
+docs/GroupKerberosSourceConnectionRequest.md
+docs/GroupLDAPSourceConnection.md
+docs/GroupLDAPSourceConnectionRequest.md
+docs/GroupMatchingModeEnum.md
+docs/GroupOAuthSourceConnection.md
+docs/GroupOAuthSourceConnectionRequest.md
+docs/GroupPlexSourceConnection.md
+docs/GroupPlexSourceConnectionRequest.md
+docs/GroupRequest.md
+docs/GroupSAMLSourceConnection.md
+docs/GroupSAMLSourceConnectionRequest.md
+docs/GroupSourceConnection.md
+docs/GroupSourceConnectionRequest.md
+docs/GroupTelegramSourceConnection.md
+docs/GroupTelegramSourceConnectionRequest.md
+docs/Hardware.md
+docs/HardwareRequest.md
+docs/IdentificationChallenge.md
+docs/IdentificationChallengeResponseRequest.md
+docs/IdentificationStage.md
+docs/IdentificationStageRequest.md
+docs/IframeLogoutChallenge.md
+docs/IframeLogoutChallengeResponseRequest.md
+docs/ImpersonationRequest.md
+docs/InitialPermissions.md
+docs/InitialPermissionsRequest.md
+docs/InstallID.md
+docs/IntentEnum.md
+docs/InvalidResponseActionEnum.md
+docs/Invitation.md
+docs/InvitationRequest.md
+docs/InvitationSendEmailRequest.md
+docs/InvitationStage.md
+docs/InvitationStageRequest.md
+docs/IssuerModeEnum.md
+docs/KadminTypeEnum.md
+docs/KerberosSource.md
+docs/KerberosSourcePropertyMapping.md
+docs/KerberosSourcePropertyMappingRequest.md
+docs/KerberosSourceRequest.md
+docs/KeyTypeEnum.md
+docs/KubernetesServiceConnection.md
+docs/KubernetesServiceConnectionRequest.md
+docs/LDAPAPIAccessMode.md
+docs/LDAPCheckAccess.md
+docs/LDAPDebug.md
+docs/LDAPOutpostConfig.md
+docs/LDAPProvider.md
+docs/LDAPProviderRequest.md
+docs/LDAPSource.md
+docs/LDAPSourcePropertyMapping.md
+docs/LDAPSourcePropertyMappingRequest.md
+docs/LDAPSourceRequest.md
+docs/LangEnum.md
+docs/LastTaskStatusEnum.md
+docs/License.md
+docs/LicenseFlagsEnum.md
+docs/LicenseForecast.md
+docs/LicenseRequest.md
+docs/LicenseStatusEnum.md
+docs/LicenseSummary.md
+docs/LicenseSummaryStatusEnum.md
+docs/LifecycleApi.md
+docs/LifecycleIteration.md
+docs/LifecycleIterationRequest.md
+docs/LifecycleIterationStateEnum.md
+docs/LifecycleRule.md
+docs/LifecycleRuleRequest.md
+docs/Link.md
+docs/LogEvent.md
+docs/LogLevelEnum.md
+docs/LoginChallengeTypes.md
+docs/LoginSource.md
+docs/LogoutURL.md
+docs/MDMConfigRequest.md
+docs/MDMConfigResponse.md
+docs/ManagedApi.md
+docs/MatchingModeEnum.md
+docs/Metadata.md
+docs/MicrosoftEntraProvider.md
+docs/MicrosoftEntraProviderGroup.md
+docs/MicrosoftEntraProviderGroupRequest.md
+docs/MicrosoftEntraProviderMapping.md
+docs/MicrosoftEntraProviderMappingRequest.md
+docs/MicrosoftEntraProviderRequest.md
+docs/MicrosoftEntraProviderUser.md
+docs/MicrosoftEntraProviderUserRequest.md
+docs/ModelEnum.md
+docs/ModelRequest.md
+docs/MutualTLSStage.md
+docs/MutualTLSStageRequest.md
+docs/NativeLogoutChallenge.md
+docs/NativeLogoutChallengeResponseRequest.md
+docs/Network.md
+docs/NetworkBindingEnum.md
+docs/NetworkInterface.md
+docs/NetworkInterfaceRequest.md
+docs/NetworkRequest.md
+docs/NotConfiguredActionEnum.md
+docs/Notification.md
+docs/NotificationRequest.md
+docs/NotificationRule.md
+docs/NotificationRuleRequest.md
+docs/NotificationTransport.md
+docs/NotificationTransportRequest.md
+docs/NotificationTransportTest.md
+docs/NotificationWebhookMapping.md
+docs/NotificationWebhookMappingRequest.md
+docs/OAuth2Provider.md
+docs/OAuth2ProviderLogoutMethodEnum.md
+docs/OAuth2ProviderRequest.md
+docs/OAuth2ProviderSetupURLs.md
+docs/OAuthDeviceCodeChallenge.md
+docs/OAuthDeviceCodeChallengeResponseRequest.md
+docs/OAuthDeviceCodeFinishChallenge.md
+docs/OAuthDeviceCodeFinishChallengeResponseRequest.md
+docs/OAuthSource.md
+docs/OAuthSourcePropertyMapping.md
+docs/OAuthSourcePropertyMappingRequest.md
+docs/OAuthSourceRequest.md
+docs/Oauth2Api.md
+docs/OpenIDConnectConfiguration.md
+docs/OperatingSystem.md
+docs/OperatingSystemRequest.md
+docs/OutgoingSyncDeleteAction.md
+docs/Outpost.md
+docs/OutpostDefaultConfig.md
+docs/OutpostHealth.md
+docs/OutpostRequest.md
+docs/OutpostTypeEnum.md
+docs/OutpostsApi.md
+docs/PKCEMethodEnum.md
+docs/PaginatedAccountLockdownStageList.md
+docs/PaginatedAgentConnectorList.md
+docs/PaginatedAppleIndependentSecureEnclaveList.md
+docs/PaginatedApplicationEntitlementList.md
+docs/PaginatedApplicationList.md
+docs/PaginatedAuthenticatedSessionList.md
+docs/PaginatedAuthenticatorDuoStageList.md
+docs/PaginatedAuthenticatorEmailStageList.md
+docs/PaginatedAuthenticatorEndpointGDTCStageList.md
+docs/PaginatedAuthenticatorSMSStageList.md
+docs/PaginatedAuthenticatorStaticStageList.md
+docs/PaginatedAuthenticatorTOTPStageList.md
+docs/PaginatedAuthenticatorValidateStageList.md
+docs/PaginatedAuthenticatorWebAuthnStageList.md
+docs/PaginatedBlueprintInstanceList.md
+docs/PaginatedBrandList.md
+docs/PaginatedCaptchaStageList.md
+docs/PaginatedCertificateKeyPairList.md
+docs/PaginatedConnectionTokenList.md
+docs/PaginatedConnectorList.md
+docs/PaginatedConsentStageList.md
+docs/PaginatedDataExportList.md
+docs/PaginatedDenyStageList.md
+docs/PaginatedDeviceAccessGroupList.md
+docs/PaginatedDeviceUserBindingList.md
+docs/PaginatedDockerServiceConnectionList.md
+docs/PaginatedDomainList.md
+docs/PaginatedDummyPolicyList.md
+docs/PaginatedDummyStageList.md
+docs/PaginatedDuoDeviceList.md
+docs/PaginatedEmailDeviceList.md
+docs/PaginatedEmailStageList.md
+docs/PaginatedEndpointDeviceList.md
+docs/PaginatedEndpointList.md
+docs/PaginatedEndpointStageList.md
+docs/PaginatedEnrollmentTokenList.md
+docs/PaginatedEventList.md
+docs/PaginatedEventMatcherPolicyList.md
+docs/PaginatedExpiringBaseGrantModelList.md
+docs/PaginatedExpressionPolicyList.md
+docs/PaginatedExtraRoleObjectPermissionList.md
+docs/PaginatedFleetConnectorList.md
+docs/PaginatedFlowList.md
+docs/PaginatedFlowStageBindingList.md
+docs/PaginatedGeoIPPolicyList.md
+docs/PaginatedGoogleChromeConnectorList.md
+docs/PaginatedGoogleEndpointDeviceList.md
+docs/PaginatedGoogleWorkspaceProviderGroupList.md
+docs/PaginatedGoogleWorkspaceProviderList.md
+docs/PaginatedGoogleWorkspaceProviderMappingList.md
+docs/PaginatedGoogleWorkspaceProviderUserList.md
+docs/PaginatedGroupKerberosSourceConnectionList.md
+docs/PaginatedGroupLDAPSourceConnectionList.md
+docs/PaginatedGroupList.md
+docs/PaginatedGroupOAuthSourceConnectionList.md
+docs/PaginatedGroupPlexSourceConnectionList.md
+docs/PaginatedGroupSAMLSourceConnectionList.md
+docs/PaginatedGroupSourceConnectionList.md
+docs/PaginatedGroupTelegramSourceConnectionList.md
+docs/PaginatedIdentificationStageList.md
+docs/PaginatedInitialPermissionsList.md
+docs/PaginatedInvitationList.md
+docs/PaginatedInvitationStageList.md
+docs/PaginatedKerberosSourceList.md
+docs/PaginatedKerberosSourcePropertyMappingList.md
+docs/PaginatedKubernetesServiceConnectionList.md
+docs/PaginatedLDAPOutpostConfigList.md
+docs/PaginatedLDAPProviderList.md
+docs/PaginatedLDAPSourceList.md
+docs/PaginatedLDAPSourcePropertyMappingList.md
+docs/PaginatedLicenseList.md
+docs/PaginatedLifecycleIterationList.md
+docs/PaginatedLifecycleRuleList.md
+docs/PaginatedMicrosoftEntraProviderGroupList.md
+docs/PaginatedMicrosoftEntraProviderList.md
+docs/PaginatedMicrosoftEntraProviderMappingList.md
+docs/PaginatedMicrosoftEntraProviderUserList.md
+docs/PaginatedMutualTLSStageList.md
+docs/PaginatedNotificationList.md
+docs/PaginatedNotificationRuleList.md
+docs/PaginatedNotificationTransportList.md
+docs/PaginatedNotificationWebhookMappingList.md
+docs/PaginatedOAuth2ProviderList.md
+docs/PaginatedOAuthSourceList.md
+docs/PaginatedOAuthSourcePropertyMappingList.md
+docs/PaginatedOutpostList.md
+docs/PaginatedPasswordExpiryPolicyList.md
+docs/PaginatedPasswordPolicyList.md
+docs/PaginatedPasswordStageList.md
+docs/PaginatedPermissionList.md
+docs/PaginatedPlexSourceList.md
+docs/PaginatedPlexSourcePropertyMappingList.md
+docs/PaginatedPolicyBindingList.md
+docs/PaginatedPolicyList.md
+docs/PaginatedPromptList.md
+docs/PaginatedPromptStageList.md
+docs/PaginatedPropertyMappingList.md
+docs/PaginatedProviderList.md
+docs/PaginatedProxyOutpostConfigList.md
+docs/PaginatedProxyProviderList.md
+docs/PaginatedRACPropertyMappingList.md
+docs/PaginatedRACProviderList.md
+docs/PaginatedRadiusOutpostConfigList.md
+docs/PaginatedRadiusProviderList.md
+docs/PaginatedRadiusProviderPropertyMappingList.md
+docs/PaginatedRedirectStageList.md
+docs/PaginatedReputationList.md
+docs/PaginatedReputationPolicyList.md
+docs/PaginatedRoleAssignedObjectPermissionList.md
+docs/PaginatedRoleList.md
+docs/PaginatedSAMLPropertyMappingList.md
+docs/PaginatedSAMLProviderList.md
+docs/PaginatedSAMLSourceList.md
+docs/PaginatedSAMLSourcePropertyMappingList.md
+docs/PaginatedSCIMMappingList.md
+docs/PaginatedSCIMProviderGroupList.md
+docs/PaginatedSCIMProviderList.md
+docs/PaginatedSCIMProviderUserList.md
+docs/PaginatedSCIMSourceGroupList.md
+docs/PaginatedSCIMSourceList.md
+docs/PaginatedSCIMSourcePropertyMappingList.md
+docs/PaginatedSCIMSourceUserList.md
+docs/PaginatedSMSDeviceList.md
+docs/PaginatedSSFProviderList.md
+docs/PaginatedSSFStreamList.md
+docs/PaginatedScheduleList.md
+docs/PaginatedScopeMappingList.md
+docs/PaginatedServiceConnectionList.md
+docs/PaginatedSourceList.md
+docs/PaginatedSourceStageList.md
+docs/PaginatedStageList.md
+docs/PaginatedStaticDeviceList.md
+docs/PaginatedTOTPDeviceList.md
+docs/PaginatedTaskList.md
+docs/PaginatedTelegramSourceList.md
+docs/PaginatedTelegramSourcePropertyMappingList.md
+docs/PaginatedTenantList.md
+docs/PaginatedTokenList.md
+docs/PaginatedTokenModelList.md
+docs/PaginatedUniquePasswordPolicyList.md
+docs/PaginatedUserConsentList.md
+docs/PaginatedUserDeleteStageList.md
+docs/PaginatedUserKerberosSourceConnectionList.md
+docs/PaginatedUserLDAPSourceConnectionList.md
+docs/PaginatedUserList.md
+docs/PaginatedUserLoginStageList.md
+docs/PaginatedUserLogoutStageList.md
+docs/PaginatedUserOAuthSourceConnectionList.md
+docs/PaginatedUserPlexSourceConnectionList.md
+docs/PaginatedUserSAMLSourceConnectionList.md
+docs/PaginatedUserSourceConnectionList.md
+docs/PaginatedUserTelegramSourceConnectionList.md
+docs/PaginatedUserWriteStageList.md
+docs/PaginatedWSFederationProviderList.md
+docs/PaginatedWebAuthnDeviceList.md
+docs/PaginatedWebAuthnDeviceTypeList.md
+docs/Pagination.md
+docs/PartialGroup.md
+docs/PartialUser.md
+docs/PasswordChallenge.md
+docs/PasswordChallengeResponseRequest.md
+docs/PasswordExpiryPolicy.md
+docs/PasswordExpiryPolicyRequest.md
+docs/PasswordPolicy.md
+docs/PasswordPolicyRequest.md
+docs/PasswordStage.md
+docs/PasswordStageRequest.md
+docs/PatchedAccountLockdownStageRequest.md
+docs/PatchedAgentConnectorRequest.md
+docs/PatchedAppleIndependentSecureEnclaveRequest.md
+docs/PatchedApplicationEntitlementRequest.md
+docs/PatchedApplicationRequest.md
+docs/PatchedAuthenticatorDuoStageRequest.md
+docs/PatchedAuthenticatorEmailStageRequest.md
+docs/PatchedAuthenticatorEndpointGDTCStageRequest.md
+docs/PatchedAuthenticatorSMSStageRequest.md
+docs/PatchedAuthenticatorStaticStageRequest.md
+docs/PatchedAuthenticatorTOTPStageRequest.md
+docs/PatchedAuthenticatorValidateStageRequest.md
+docs/PatchedAuthenticatorWebAuthnStageRequest.md
+docs/PatchedBlueprintInstanceRequest.md
+docs/PatchedBrandRequest.md
+docs/PatchedCaptchaStageRequest.md
+docs/PatchedCertificateKeyPairRequest.md
+docs/PatchedConnectionTokenRequest.md
+docs/PatchedConsentStageRequest.md
+docs/PatchedDenyStageRequest.md
+docs/PatchedDeviceAccessGroupRequest.md
+docs/PatchedDeviceUserBindingRequest.md
+docs/PatchedDockerServiceConnectionRequest.md
+docs/PatchedDomainRequest.md
+docs/PatchedDummyPolicyRequest.md
+docs/PatchedDummyStageRequest.md
+docs/PatchedDuoDeviceRequest.md
+docs/PatchedEmailDeviceRequest.md
+docs/PatchedEmailStageRequest.md
+docs/PatchedEndpointDeviceRequest.md
+docs/PatchedEndpointRequest.md
+docs/PatchedEndpointStageRequest.md
+docs/PatchedEnrollmentTokenRequest.md
+docs/PatchedEventMatcherPolicyRequest.md
+docs/PatchedEventRequest.md
+docs/PatchedExpressionPolicyRequest.md
+docs/PatchedFleetConnectorRequest.md
+docs/PatchedFlowRequest.md
+docs/PatchedFlowStageBindingRequest.md
+docs/PatchedGeoIPPolicyRequest.md
+docs/PatchedGoogleChromeConnectorRequest.md
+docs/PatchedGoogleEndpointDeviceRequest.md
+docs/PatchedGoogleWorkspaceProviderMappingRequest.md
+docs/PatchedGoogleWorkspaceProviderRequest.md
+docs/PatchedGroupKerberosSourceConnectionRequest.md
+docs/PatchedGroupLDAPSourceConnectionRequest.md
+docs/PatchedGroupOAuthSourceConnectionRequest.md
+docs/PatchedGroupPlexSourceConnectionRequest.md
+docs/PatchedGroupRequest.md
+docs/PatchedGroupSAMLSourceConnectionRequest.md
+docs/PatchedGroupSourceConnectionRequest.md
+docs/PatchedGroupTelegramSourceConnectionRequest.md
+docs/PatchedIdentificationStageRequest.md
+docs/PatchedInitialPermissionsRequest.md
+docs/PatchedInvitationRequest.md
+docs/PatchedInvitationStageRequest.md
+docs/PatchedKerberosSourcePropertyMappingRequest.md
+docs/PatchedKerberosSourceRequest.md
+docs/PatchedKubernetesServiceConnectionRequest.md
+docs/PatchedLDAPProviderRequest.md
+docs/PatchedLDAPSourcePropertyMappingRequest.md
+docs/PatchedLDAPSourceRequest.md
+docs/PatchedLicenseRequest.md
+docs/PatchedLifecycleRuleRequest.md
+docs/PatchedMicrosoftEntraProviderMappingRequest.md
+docs/PatchedMicrosoftEntraProviderRequest.md
+docs/PatchedMutualTLSStageRequest.md
+docs/PatchedNotificationRequest.md
+docs/PatchedNotificationRuleRequest.md
+docs/PatchedNotificationTransportRequest.md
+docs/PatchedNotificationWebhookMappingRequest.md
+docs/PatchedOAuth2ProviderRequest.md
+docs/PatchedOAuthSourcePropertyMappingRequest.md
+docs/PatchedOAuthSourceRequest.md
+docs/PatchedOutpostRequest.md
+docs/PatchedPasswordExpiryPolicyRequest.md
+docs/PatchedPasswordPolicyRequest.md
+docs/PatchedPasswordStageRequest.md
+docs/PatchedPermissionAssignRequest.md
+docs/PatchedPlexSourcePropertyMappingRequest.md
+docs/PatchedPlexSourceRequest.md
+docs/PatchedPolicyBindingRequest.md
+docs/PatchedPromptRequest.md
+docs/PatchedPromptStageRequest.md
+docs/PatchedProxyProviderRequest.md
+docs/PatchedRACPropertyMappingRequest.md
+docs/PatchedRACProviderRequest.md
+docs/PatchedRadiusProviderPropertyMappingRequest.md
+docs/PatchedRadiusProviderRequest.md
+docs/PatchedRedirectStageRequest.md
+docs/PatchedReputationPolicyRequest.md
+docs/PatchedRoleRequest.md
+docs/PatchedSAMLPropertyMappingRequest.md
+docs/PatchedSAMLProviderRequest.md
+docs/PatchedSAMLSourcePropertyMappingRequest.md
+docs/PatchedSAMLSourceRequest.md
+docs/PatchedSCIMMappingRequest.md
+docs/PatchedSCIMProviderRequest.md
+docs/PatchedSCIMSourceGroupRequest.md
+docs/PatchedSCIMSourcePropertyMappingRequest.md
+docs/PatchedSCIMSourceRequest.md
+docs/PatchedSCIMSourceUserRequest.md
+docs/PatchedSMSDeviceRequest.md
+docs/PatchedSSFProviderRequest.md
+docs/PatchedScheduleRequest.md
+docs/PatchedScopeMappingRequest.md
+docs/PatchedSettingsRequest.md
+docs/PatchedSettingsRequestFlags.md
+docs/PatchedSourceStageRequest.md
+docs/PatchedStaticDeviceRequest.md
+docs/PatchedTOTPDeviceRequest.md
+docs/PatchedTelegramSourcePropertyMappingRequest.md
+docs/PatchedTelegramSourceRequest.md
+docs/PatchedTenantRequest.md
+docs/PatchedTokenRequest.md
+docs/PatchedUniquePasswordPolicyRequest.md
+docs/PatchedUserDeleteStageRequest.md
+docs/PatchedUserKerberosSourceConnectionRequest.md
+docs/PatchedUserLDAPSourceConnectionRequest.md
+docs/PatchedUserLoginStageRequest.md
+docs/PatchedUserLogoutStageRequest.md
+docs/PatchedUserOAuthSourceConnectionRequest.md
+docs/PatchedUserPlexSourceConnectionRequest.md
+docs/PatchedUserRequest.md
+docs/PatchedUserSAMLSourceConnectionRequest.md
+docs/PatchedUserSourceConnectionRequest.md
+docs/PatchedUserTelegramSourceConnectionRequest.md
+docs/PatchedUserWriteStageRequest.md
+docs/PatchedWSFederationProviderRequest.md
+docs/PatchedWebAuthnDeviceRequest.md
+docs/Permission.md
+docs/PermissionAssignRequest.md
+docs/PermissionAssignResult.md
+docs/PlexAuthenticationChallenge.md
+docs/PlexAuthenticationChallengeResponseRequest.md
+docs/PlexSource.md
+docs/PlexSourcePropertyMapping.md
+docs/PlexSourcePropertyMappingRequest.md
+docs/PlexSourceRequest.md
+docs/PlexTokenRedeemRequest.md
+docs/PoliciesApi.md
+docs/Policy.md
+docs/PolicyBinding.md
+docs/PolicyBindingRequest.md
+docs/PolicyEngineMode.md
+docs/PolicyTestRequest.md
+docs/PolicyTestResult.md
+docs/Process.md
+docs/ProcessRequest.md
+docs/Prompt.md
+docs/PromptChallenge.md
+docs/PromptChallengeResponseRequest.md
+docs/PromptChoice.md
+docs/PromptRequest.md
+docs/PromptStage.md
+docs/PromptStageRequest.md
+docs/PromptTypeEnum.md
+docs/PropertyMapping.md
+docs/PropertyMappingPreview.md
+docs/PropertyMappingTestRequest.md
+docs/PropertyMappingTestResult.md
+docs/PropertymappingsApi.md
+docs/ProtocolEnum.md
+docs/Provider.md
+docs/ProviderEnum.md
+docs/ProviderModelEnum.md
+docs/ProviderTypeEnum.md
+docs/ProvidersApi.md
+docs/ProxyMode.md
+docs/ProxyOutpostConfig.md
+docs/ProxyProvider.md
+docs/ProxyProviderRequest.md
+docs/RACPropertyMapping.md
+docs/RACPropertyMappingRequest.md
+docs/RACProvider.md
+docs/RACProviderRequest.md
+docs/RacApi.md
+docs/RadiusCheckAccess.md
+docs/RadiusOutpostConfig.md
+docs/RadiusProvider.md
+docs/RadiusProviderPropertyMapping.md
+docs/RadiusProviderPropertyMappingRequest.md
+docs/RadiusProviderRequest.md
+docs/RbacApi.md
+docs/RedirectChallenge.md
+docs/RedirectChallengeResponseRequest.md
+docs/RedirectStage.md
+docs/RedirectStageModeEnum.md
+docs/RedirectStageRequest.md
+docs/RedirectURI.md
+docs/RedirectURIRequest.md
+docs/RedirectURITypeEnum.md
+docs/RelatedGroup.md
+docs/RelatedRule.md
+docs/ReportsApi.md
+docs/Reputation.md
+docs/ReputationPolicy.md
+docs/ReputationPolicyRequest.md
+docs/Review.md
+docs/ReviewRequest.md
+docs/ReviewerGroup.md
+docs/ReviewerUser.md
+docs/Role.md
+docs/RoleAssignedObjectPermission.md
+docs/RoleModelPermission.md
+docs/RoleObjectPermission.md
+docs/RoleRequest.md
+docs/RootApi.md
+docs/SAMLBindingsEnum.md
+docs/SAMLLogoutMethods.md
+docs/SAMLMetadata.md
+docs/SAMLNameIDPolicyEnum.md
+docs/SAMLPropertyMapping.md
+docs/SAMLPropertyMappingRequest.md
+docs/SAMLProvider.md
+docs/SAMLProviderRequest.md
+docs/SAMLSource.md
+docs/SAMLSourcePropertyMapping.md
+docs/SAMLSourcePropertyMappingRequest.md
+docs/SAMLSourceRequest.md
+docs/SCIMAuthenticationModeEnum.md
+docs/SCIMMapping.md
+docs/SCIMMappingRequest.md
+docs/SCIMProvider.md
+docs/SCIMProviderGroup.md
+docs/SCIMProviderGroupRequest.md
+docs/SCIMProviderRequest.md
+docs/SCIMProviderUser.md
+docs/SCIMProviderUserRequest.md
+docs/SCIMSource.md
+docs/SCIMSourceGroup.md
+docs/SCIMSourceGroupRequest.md
+docs/SCIMSourcePropertyMapping.md
+docs/SCIMSourcePropertyMappingRequest.md
+docs/SCIMSourceRequest.md
+docs/SCIMSourceUser.md
+docs/SCIMSourceUserRequest.md
+docs/SMSDevice.md
+docs/SMSDeviceRequest.md
+docs/SSFProvider.md
+docs/SSFProviderRequest.md
+docs/SSFStream.md
+docs/SSFStreamStatusEnum.md
+docs/Schedule.md
+docs/ScheduleRequest.md
+docs/SchemaApi.md
+docs/ScopeMapping.md
+docs/ScopeMappingRequest.md
+docs/SelectableStage.md
+docs/ServiceConnection.md
+docs/ServiceConnectionState.md
+docs/SessionEndChallenge.md
+docs/SessionUser.md
+docs/Settings.md
+docs/SettingsRequest.md
+docs/SeverityEnum.md
+docs/ShellChallenge.md
+docs/SignatureAlgorithmEnum.md
+docs/Software.md
+docs/SoftwareRequest.md
+docs/Source.md
+docs/SourceStage.md
+docs/SourceStageRequest.md
+docs/SourceType.md
+docs/SourcesApi.md
+docs/SsfApi.md
+docs/Stage.md
+docs/StageModeEnum.md
+docs/StagePrompt.md
+docs/StagesApi.md
+docs/StaticDevice.md
+docs/StaticDeviceRequest.md
+docs/StaticDeviceToken.md
+docs/SubModeEnum.md
+docs/SyncObjectModelEnum.md
+docs/SyncObjectRequest.md
+docs/SyncObjectResult.md
+docs/SyncOutgoingTriggerModeEnum.md
+docs/SyncStatus.md
+docs/SystemInfo.md
+docs/SystemInfoRuntime.md
+docs/TOTPDevice.md
+docs/TOTPDeviceRequest.md
+docs/Task.md
+docs/TaskAggregatedStatusEnum.md
+docs/TaskStatusEnum.md
+docs/TasksApi.md
+docs/TelegramAuthRequest.md
+docs/TelegramChallengeResponseRequest.md
+docs/TelegramLoginChallenge.md
+docs/TelegramSource.md
+docs/TelegramSourcePropertyMapping.md
+docs/TelegramSourcePropertyMappingRequest.md
+docs/TelegramSourceRequest.md
+docs/Tenant.md
+docs/TenantAdminGroupRequestRequest.md
+docs/TenantRecoveryKeyRequestRequest.md
+docs/TenantRecoveryKeyResponse.md
+docs/TenantRequest.md
+docs/TenantsApi.md
+docs/ThemedUrls.md
+docs/Token.md
+docs/TokenModel.md
+docs/TokenRequest.md
+docs/TokenSetKeyRequest.md
+docs/TokenView.md
+docs/TransactionApplicationRequest.md
+docs/TransactionApplicationResponse.md
+docs/TransactionPolicyBindingRequest.md
+docs/TransportModeEnum.md
+docs/TypeCreate.md
+docs/UiThemeEnum.md
+docs/UniquePasswordPolicy.md
+docs/UniquePasswordPolicyRequest.md
+docs/UsageEnum.md
+docs/UsedBy.md
+docs/UsedByActionEnum.md
+docs/User.md
+docs/UserAccountLockdownRequest.md
+docs/UserAccountRequest.md
+docs/UserAccountSerializerForRoleRequest.md
+docs/UserAttributeEnum.md
+docs/UserConsent.md
+docs/UserCreationModeEnum.md
+docs/UserDeleteStage.md
+docs/UserDeleteStageRequest.md
+docs/UserFieldsEnum.md
+docs/UserKerberosSourceConnection.md
+docs/UserKerberosSourceConnectionRequest.md
+docs/UserLDAPSourceConnection.md
+docs/UserLDAPSourceConnectionRequest.md
+docs/UserLoginChallenge.md
+docs/UserLoginChallengeResponseRequest.md
+docs/UserLoginStage.md
+docs/UserLoginStageRequest.md
+docs/UserLogoutStage.md
+docs/UserLogoutStageRequest.md
+docs/UserMatchingModeEnum.md
+docs/UserOAuthSourceConnection.md
+docs/UserOAuthSourceConnectionRequest.md
+docs/UserPasswordHashSetRequest.md
+docs/UserPasswordSetRequest.md
+docs/UserPath.md
+docs/UserPlexSourceConnection.md
+docs/UserPlexSourceConnectionRequest.md
+docs/UserRecoveryEmailRequest.md
+docs/UserRecoveryLinkRequest.md
+docs/UserRequest.md
+docs/UserSAMLSourceConnection.md
+docs/UserSAMLSourceConnectionRequest.md
+docs/UserSelf.md
+docs/UserSelfGroups.md
+docs/UserSelfRoles.md
+docs/UserServiceAccountRequest.md
+docs/UserServiceAccountResponse.md
+docs/UserSetting.md
+docs/UserSourceConnection.md
+docs/UserSourceConnectionRequest.md
+docs/UserTelegramSourceConnection.md
+docs/UserTelegramSourceConnectionRequest.md
+docs/UserTypeEnum.md
+docs/UserVerificationEnum.md
+docs/UserWriteStage.md
+docs/UserWriteStageRequest.md
+docs/ValidationError.md
+docs/VendorEnum.md
+docs/Version.md
+docs/VersionHistory.md
+docs/WSFederationProvider.md
+docs/WSFederationProviderRequest.md
+docs/WebAuthnDevice.md
+docs/WebAuthnDeviceRequest.md
+docs/WebAuthnDeviceType.md
+docs/WebAuthnHintEnum.md
+docs/Worker.md
+git_push.sh
+pyproject.toml
+requirements.txt
+setup.cfg
+setup.py
+test-requirements.txt
+test/__init__.py
+test/test_access_denied_challenge.py
+test/test_account_lockdown_stage.py
+test/test_account_lockdown_stage_request.py
+test/test_admin_api.py
+test/test_agent_authentication_response.py
+test/test_agent_config.py
+test/test_agent_connector.py
+test/test_agent_connector_request.py
+test/test_agent_psso_device_registration_request.py
+test/test_agent_psso_device_registration_response.py
+test/test_agent_psso_user_registration_request.py
+test/test_agent_token_response.py
+test/test_alg_enum.py
+test/test_app.py
+test/test_app_enum.py
+test/test_apple_challenge_response_request.py
+test/test_apple_independent_secure_enclave.py
+test/test_apple_independent_secure_enclave_request.py
+test/test_apple_login_challenge.py
+test/test_application.py
+test/test_application_entitlement.py
+test/test_application_entitlement_request.py
+test/test_application_request.py
+test/test_auth_type_enum.py
+test/test_authenticated_session.py
+test/test_authenticated_session_asn.py
+test/test_authenticated_session_geo_ip.py
+test/test_authenticated_session_user_agent.py
+test/test_authenticated_session_user_agent_device.py
+test/test_authenticated_session_user_agent_os.py
+test/test_authenticated_session_user_agent_user_agent.py
+test/test_authentication_enum.py
+test/test_authenticator_attachment_enum.py
+test/test_authenticator_duo_challenge.py
+test/test_authenticator_duo_challenge_response_request.py
+test/test_authenticator_duo_stage.py
+test/test_authenticator_duo_stage_device_import_response.py
+test/test_authenticator_duo_stage_manual_device_import_request.py
+test/test_authenticator_duo_stage_request.py
+test/test_authenticator_email_challenge.py
+test/test_authenticator_email_challenge_response_request.py
+test/test_authenticator_email_stage.py
+test/test_authenticator_email_stage_request.py
+test/test_authenticator_endpoint_gdtc_stage.py
+test/test_authenticator_endpoint_gdtc_stage_request.py
+test/test_authenticator_sms_challenge.py
+test/test_authenticator_sms_challenge_response_request.py
+test/test_authenticator_sms_stage.py
+test/test_authenticator_sms_stage_request.py
+test/test_authenticator_static_challenge.py
+test/test_authenticator_static_challenge_response_request.py
+test/test_authenticator_static_stage.py
+test/test_authenticator_static_stage_request.py
+test/test_authenticator_totp_challenge.py
+test/test_authenticator_totp_challenge_response_request.py
+test/test_authenticator_totp_stage.py
+test/test_authenticator_totp_stage_request.py
+test/test_authenticator_validate_stage.py
+test/test_authenticator_validate_stage_request.py
+test/test_authenticator_validation_challenge.py
+test/test_authenticator_validation_challenge_response_request.py
+test/test_authenticator_web_authn_challenge.py
+test/test_authenticator_web_authn_challenge_response_request.py
+test/test_authenticator_web_authn_stage.py
+test/test_authenticator_web_authn_stage_request.py
+test/test_authenticators_api.py
+test/test_authorization_code_auth_method_enum.py
+test/test_auto_submit_challenge_response_request.py
+test/test_autosubmit_challenge.py
+test/test_backends_enum.py
+test/test_binding_type_enum.py
+test/test_blueprint_file.py
+test/test_blueprint_import_result.py
+test/test_blueprint_instance.py
+test/test_blueprint_instance_request.py
+test/test_blueprint_instance_status_enum.py
+test/test_brand.py
+test/test_brand_request.py
+test/test_bulk_delete_session_response.py
+test/test_cache.py
+test/test_capabilities_enum.py
+test/test_captcha_challenge.py
+test/test_captcha_challenge_response_request.py
+test/test_captcha_stage.py
+test/test_captcha_stage_request.py
+test/test_cert_attribute_enum.py
+test/test_certificate_data.py
+test/test_certificate_generation_request.py
+test/test_certificate_key_pair.py
+test/test_certificate_key_pair_key_type_enum.py
+test/test_certificate_key_pair_request.py
+test/test_challenge_types.py
+test/test_client_type_enum.py
+test/test_compatibility_mode_enum.py
+test/test_config.py
+test/test_connection_token.py
+test/test_connection_token_request.py
+test/test_connector.py
+test/test_consent_challenge.py
+test/test_consent_challenge_response_request.py
+test/test_consent_mode_enum.py
+test/test_consent_permission.py
+test/test_consent_stage.py
+test/test_consent_stage_request.py
+test/test_content_type.py
+test/test_content_type_enum.py
+test/test_contextual_flow_info.py
+test/test_contextual_flow_info_layout_enum.py
+test/test_core_api.py
+test/test_country_code_enum.py
+test/test_crypto_api.py
+test/test_current_brand.py
+test/test_current_brand_flags.py
+test/test_data_export.py
+test/test_delivery_method_enum.py
+test/test_denied_action_enum.py
+test/test_deny_stage.py
+test/test_deny_stage_request.py
+test/test_detailed_country.py
+test/test_device.py
+test/test_device_access_group.py
+test/test_device_access_group_request.py
+test/test_device_challenge.py
+test/test_device_challenge_request.py
+test/test_device_classes_enum.py
+test/test_device_connection.py
+test/test_device_fact_snapshot.py
+test/test_device_facts.py
+test/test_device_facts_os_family.py
+test/test_device_facts_request.py
+test/test_device_group.py
+test/test_device_group_request.py
+test/test_device_summary.py
+test/test_device_user.py
+test/test_device_user_binding.py
+test/test_device_user_binding_request.py
+test/test_device_user_request.py
+test/test_digest_algorithm_enum.py
+test/test_digits_enum.py
+test/test_disk.py
+test/test_disk_request.py
+test/test_docker_service_connection.py
+test/test_docker_service_connection_request.py
+test/test_domain.py
+test/test_domain_request.py
+test/test_dummy_challenge.py
+test/test_dummy_challenge_response_request.py
+test/test_dummy_policy.py
+test/test_dummy_policy_request.py
+test/test_dummy_stage.py
+test/test_dummy_stage_request.py
+test/test_duo_device.py
+test/test_duo_device_enrollment_status.py
+test/test_duo_device_request.py
+test/test_duo_response_enum.py
+test/test_email_challenge.py
+test/test_email_challenge_response_request.py
+test/test_email_device.py
+test/test_email_device_request.py
+test/test_email_stage.py
+test/test_email_stage_request.py
+test/test_endpoint.py
+test/test_endpoint_agent_challenge.py
+test/test_endpoint_agent_challenge_response_request.py
+test/test_endpoint_auth_mode_enum.py
+test/test_endpoint_device.py
+test/test_endpoint_device_details.py
+test/test_endpoint_device_request.py
+test/test_endpoint_request.py
+test/test_endpoint_stage.py
+test/test_endpoint_stage_request.py
+test/test_endpoints_api.py
+test/test_enroll_request.py
+test/test_enrollment_token.py
+test/test_enrollment_token_request.py
+test/test_enterprise_api.py
+test/test_error_detail.py
+test/test_error_reporting_config.py
+test/test_event.py
+test/test_event_actions.py
+test/test_event_matcher_policy.py
+test/test_event_matcher_policy_request.py
+test/test_event_request.py
+test/test_event_stats.py
+test/test_event_top_per_user.py
+test/test_event_volume.py
+test/test_events_api.py
+test/test_events_requested_enum.py
+test/test_expiring_base_grant_model.py
+test/test_expression_policy.py
+test/test_expression_policy_request.py
+test/test_extra_role_object_permission.py
+test/test_file_list.py
+test/test_fleet_connector.py
+test/test_fleet_connector_request.py
+test/test_flow.py
+test/test_flow_challenge_response_request.py
+test/test_flow_designation_enum.py
+test/test_flow_diagram.py
+test/test_flow_error_challenge.py
+test/test_flow_inspection.py
+test/test_flow_inspector_plan.py
+test/test_flow_layout_enum.py
+test/test_flow_request.py
+test/test_flow_set.py
+test/test_flow_stage_binding.py
+test/test_flow_stage_binding_request.py
+test/test_flows_api.py
+test/test_footer_link.py
+test/test_force_binding_enum.py
+test/test_format_enum.py
+test/test_frame_challenge.py
+test/test_frame_challenge_response_request.py
+test/test_generic_error.py
+test/test_geo_ip_policy.py
+test/test_geo_ip_policy_countries_obj_inner.py
+test/test_geo_ip_policy_request.py
+test/test_geoip_binding_enum.py
+test/test_global_task_status.py
+test/test_google_chrome_connector.py
+test/test_google_chrome_connector_request.py
+test/test_google_endpoint_device.py
+test/test_google_endpoint_device_request.py
+test/test_google_workspace_provider.py
+test/test_google_workspace_provider_group.py
+test/test_google_workspace_provider_group_request.py
+test/test_google_workspace_provider_mapping.py
+test/test_google_workspace_provider_mapping_request.py
+test/test_google_workspace_provider_request.py
+test/test_google_workspace_provider_user.py
+test/test_google_workspace_provider_user_request.py
+test/test_grant_types_enum.py
+test/test_group.py
+test/test_group_kerberos_source_connection.py
+test/test_group_kerberos_source_connection_request.py
+test/test_group_ldap_source_connection.py
+test/test_group_ldap_source_connection_request.py
+test/test_group_matching_mode_enum.py
+test/test_group_o_auth_source_connection.py
+test/test_group_o_auth_source_connection_request.py
+test/test_group_plex_source_connection.py
+test/test_group_plex_source_connection_request.py
+test/test_group_request.py
+test/test_group_saml_source_connection.py
+test/test_group_saml_source_connection_request.py
+test/test_group_source_connection.py
+test/test_group_source_connection_request.py
+test/test_group_telegram_source_connection.py
+test/test_group_telegram_source_connection_request.py
+test/test_hardware.py
+test/test_hardware_request.py
+test/test_identification_challenge.py
+test/test_identification_challenge_response_request.py
+test/test_identification_stage.py
+test/test_identification_stage_request.py
+test/test_iframe_logout_challenge.py
+test/test_iframe_logout_challenge_response_request.py
+test/test_impersonation_request.py
+test/test_initial_permissions.py
+test/test_initial_permissions_request.py
+test/test_install_id.py
+test/test_intent_enum.py
+test/test_invalid_response_action_enum.py
+test/test_invitation.py
+test/test_invitation_request.py
+test/test_invitation_send_email_request.py
+test/test_invitation_stage.py
+test/test_invitation_stage_request.py
+test/test_issuer_mode_enum.py
+test/test_kadmin_type_enum.py
+test/test_kerberos_source.py
+test/test_kerberos_source_property_mapping.py
+test/test_kerberos_source_property_mapping_request.py
+test/test_kerberos_source_request.py
+test/test_key_type_enum.py
+test/test_kubernetes_service_connection.py
+test/test_kubernetes_service_connection_request.py
+test/test_lang_enum.py
+test/test_last_task_status_enum.py
+test/test_ldap_check_access.py
+test/test_ldap_debug.py
+test/test_ldap_outpost_config.py
+test/test_ldap_provider.py
+test/test_ldap_provider_request.py
+test/test_ldap_source.py
+test/test_ldap_source_property_mapping.py
+test/test_ldap_source_property_mapping_request.py
+test/test_ldap_source_request.py
+test/test_ldapapi_access_mode.py
+test/test_license.py
+test/test_license_flags_enum.py
+test/test_license_forecast.py
+test/test_license_request.py
+test/test_license_status_enum.py
+test/test_license_summary.py
+test/test_license_summary_status_enum.py
+test/test_lifecycle_api.py
+test/test_lifecycle_iteration.py
+test/test_lifecycle_iteration_request.py
+test/test_lifecycle_iteration_state_enum.py
+test/test_lifecycle_rule.py
+test/test_lifecycle_rule_request.py
+test/test_link.py
+test/test_log_event.py
+test/test_log_level_enum.py
+test/test_login_challenge_types.py
+test/test_login_source.py
+test/test_logout_url.py
+test/test_managed_api.py
+test/test_matching_mode_enum.py
+test/test_mdm_config_request.py
+test/test_mdm_config_response.py
+test/test_metadata.py
+test/test_microsoft_entra_provider.py
+test/test_microsoft_entra_provider_group.py
+test/test_microsoft_entra_provider_group_request.py
+test/test_microsoft_entra_provider_mapping.py
+test/test_microsoft_entra_provider_mapping_request.py
+test/test_microsoft_entra_provider_request.py
+test/test_microsoft_entra_provider_user.py
+test/test_microsoft_entra_provider_user_request.py
+test/test_model_enum.py
+test/test_model_request.py
+test/test_mutual_tls_stage.py
+test/test_mutual_tls_stage_request.py
+test/test_native_logout_challenge.py
+test/test_native_logout_challenge_response_request.py
+test/test_network.py
+test/test_network_binding_enum.py
+test/test_network_interface.py
+test/test_network_interface_request.py
+test/test_network_request.py
+test/test_not_configured_action_enum.py
+test/test_notification.py
+test/test_notification_request.py
+test/test_notification_rule.py
+test/test_notification_rule_request.py
+test/test_notification_transport.py
+test/test_notification_transport_request.py
+test/test_notification_transport_test.py
+test/test_notification_webhook_mapping.py
+test/test_notification_webhook_mapping_request.py
+test/test_o_auth2_provider.py
+test/test_o_auth2_provider_logout_method_enum.py
+test/test_o_auth2_provider_request.py
+test/test_o_auth2_provider_setup_urls.py
+test/test_o_auth_device_code_challenge.py
+test/test_o_auth_device_code_challenge_response_request.py
+test/test_o_auth_device_code_finish_challenge.py
+test/test_o_auth_device_code_finish_challenge_response_request.py
+test/test_o_auth_source.py
+test/test_o_auth_source_property_mapping.py
+test/test_o_auth_source_property_mapping_request.py
+test/test_o_auth_source_request.py
+test/test_oauth2_api.py
+test/test_open_id_connect_configuration.py
+test/test_operating_system.py
+test/test_operating_system_request.py
+test/test_outgoing_sync_delete_action.py
+test/test_outpost.py
+test/test_outpost_default_config.py
+test/test_outpost_health.py
+test/test_outpost_request.py
+test/test_outpost_type_enum.py
+test/test_outposts_api.py
+test/test_paginated_account_lockdown_stage_list.py
+test/test_paginated_agent_connector_list.py
+test/test_paginated_apple_independent_secure_enclave_list.py
+test/test_paginated_application_entitlement_list.py
+test/test_paginated_application_list.py
+test/test_paginated_authenticated_session_list.py
+test/test_paginated_authenticator_duo_stage_list.py
+test/test_paginated_authenticator_email_stage_list.py
+test/test_paginated_authenticator_endpoint_gdtc_stage_list.py
+test/test_paginated_authenticator_sms_stage_list.py
+test/test_paginated_authenticator_static_stage_list.py
+test/test_paginated_authenticator_totp_stage_list.py
+test/test_paginated_authenticator_validate_stage_list.py
+test/test_paginated_authenticator_web_authn_stage_list.py
+test/test_paginated_blueprint_instance_list.py
+test/test_paginated_brand_list.py
+test/test_paginated_captcha_stage_list.py
+test/test_paginated_certificate_key_pair_list.py
+test/test_paginated_connection_token_list.py
+test/test_paginated_connector_list.py
+test/test_paginated_consent_stage_list.py
+test/test_paginated_data_export_list.py
+test/test_paginated_deny_stage_list.py
+test/test_paginated_device_access_group_list.py
+test/test_paginated_device_user_binding_list.py
+test/test_paginated_docker_service_connection_list.py
+test/test_paginated_domain_list.py
+test/test_paginated_dummy_policy_list.py
+test/test_paginated_dummy_stage_list.py
+test/test_paginated_duo_device_list.py
+test/test_paginated_email_device_list.py
+test/test_paginated_email_stage_list.py
+test/test_paginated_endpoint_device_list.py
+test/test_paginated_endpoint_list.py
+test/test_paginated_endpoint_stage_list.py
+test/test_paginated_enrollment_token_list.py
+test/test_paginated_event_list.py
+test/test_paginated_event_matcher_policy_list.py
+test/test_paginated_expiring_base_grant_model_list.py
+test/test_paginated_expression_policy_list.py
+test/test_paginated_extra_role_object_permission_list.py
+test/test_paginated_fleet_connector_list.py
+test/test_paginated_flow_list.py
+test/test_paginated_flow_stage_binding_list.py
+test/test_paginated_geo_ip_policy_list.py
+test/test_paginated_google_chrome_connector_list.py
+test/test_paginated_google_endpoint_device_list.py
+test/test_paginated_google_workspace_provider_group_list.py
+test/test_paginated_google_workspace_provider_list.py
+test/test_paginated_google_workspace_provider_mapping_list.py
+test/test_paginated_google_workspace_provider_user_list.py
+test/test_paginated_group_kerberos_source_connection_list.py
+test/test_paginated_group_ldap_source_connection_list.py
+test/test_paginated_group_list.py
+test/test_paginated_group_o_auth_source_connection_list.py
+test/test_paginated_group_plex_source_connection_list.py
+test/test_paginated_group_saml_source_connection_list.py
+test/test_paginated_group_source_connection_list.py
+test/test_paginated_group_telegram_source_connection_list.py
+test/test_paginated_identification_stage_list.py
+test/test_paginated_initial_permissions_list.py
+test/test_paginated_invitation_list.py
+test/test_paginated_invitation_stage_list.py
+test/test_paginated_kerberos_source_list.py
+test/test_paginated_kerberos_source_property_mapping_list.py
+test/test_paginated_kubernetes_service_connection_list.py
+test/test_paginated_ldap_outpost_config_list.py
+test/test_paginated_ldap_provider_list.py
+test/test_paginated_ldap_source_list.py
+test/test_paginated_ldap_source_property_mapping_list.py
+test/test_paginated_license_list.py
+test/test_paginated_lifecycle_iteration_list.py
+test/test_paginated_lifecycle_rule_list.py
+test/test_paginated_microsoft_entra_provider_group_list.py
+test/test_paginated_microsoft_entra_provider_list.py
+test/test_paginated_microsoft_entra_provider_mapping_list.py
+test/test_paginated_microsoft_entra_provider_user_list.py
+test/test_paginated_mutual_tls_stage_list.py
+test/test_paginated_notification_list.py
+test/test_paginated_notification_rule_list.py
+test/test_paginated_notification_transport_list.py
+test/test_paginated_notification_webhook_mapping_list.py
+test/test_paginated_o_auth2_provider_list.py
+test/test_paginated_o_auth_source_list.py
+test/test_paginated_o_auth_source_property_mapping_list.py
+test/test_paginated_outpost_list.py
+test/test_paginated_password_expiry_policy_list.py
+test/test_paginated_password_policy_list.py
+test/test_paginated_password_stage_list.py
+test/test_paginated_permission_list.py
+test/test_paginated_plex_source_list.py
+test/test_paginated_plex_source_property_mapping_list.py
+test/test_paginated_policy_binding_list.py
+test/test_paginated_policy_list.py
+test/test_paginated_prompt_list.py
+test/test_paginated_prompt_stage_list.py
+test/test_paginated_property_mapping_list.py
+test/test_paginated_provider_list.py
+test/test_paginated_proxy_outpost_config_list.py
+test/test_paginated_proxy_provider_list.py
+test/test_paginated_rac_property_mapping_list.py
+test/test_paginated_rac_provider_list.py
+test/test_paginated_radius_outpost_config_list.py
+test/test_paginated_radius_provider_list.py
+test/test_paginated_radius_provider_property_mapping_list.py
+test/test_paginated_redirect_stage_list.py
+test/test_paginated_reputation_list.py
+test/test_paginated_reputation_policy_list.py
+test/test_paginated_role_assigned_object_permission_list.py
+test/test_paginated_role_list.py
+test/test_paginated_saml_property_mapping_list.py
+test/test_paginated_saml_provider_list.py
+test/test_paginated_saml_source_list.py
+test/test_paginated_saml_source_property_mapping_list.py
+test/test_paginated_schedule_list.py
+test/test_paginated_scim_mapping_list.py
+test/test_paginated_scim_provider_group_list.py
+test/test_paginated_scim_provider_list.py
+test/test_paginated_scim_provider_user_list.py
+test/test_paginated_scim_source_group_list.py
+test/test_paginated_scim_source_list.py
+test/test_paginated_scim_source_property_mapping_list.py
+test/test_paginated_scim_source_user_list.py
+test/test_paginated_scope_mapping_list.py
+test/test_paginated_service_connection_list.py
+test/test_paginated_sms_device_list.py
+test/test_paginated_source_list.py
+test/test_paginated_source_stage_list.py
+test/test_paginated_ssf_provider_list.py
+test/test_paginated_ssf_stream_list.py
+test/test_paginated_stage_list.py
+test/test_paginated_static_device_list.py
+test/test_paginated_task_list.py
+test/test_paginated_telegram_source_list.py
+test/test_paginated_telegram_source_property_mapping_list.py
+test/test_paginated_tenant_list.py
+test/test_paginated_token_list.py
+test/test_paginated_token_model_list.py
+test/test_paginated_totp_device_list.py
+test/test_paginated_unique_password_policy_list.py
+test/test_paginated_user_consent_list.py
+test/test_paginated_user_delete_stage_list.py
+test/test_paginated_user_kerberos_source_connection_list.py
+test/test_paginated_user_ldap_source_connection_list.py
+test/test_paginated_user_list.py
+test/test_paginated_user_login_stage_list.py
+test/test_paginated_user_logout_stage_list.py
+test/test_paginated_user_o_auth_source_connection_list.py
+test/test_paginated_user_plex_source_connection_list.py
+test/test_paginated_user_saml_source_connection_list.py
+test/test_paginated_user_source_connection_list.py
+test/test_paginated_user_telegram_source_connection_list.py
+test/test_paginated_user_write_stage_list.py
+test/test_paginated_web_authn_device_list.py
+test/test_paginated_web_authn_device_type_list.py
+test/test_paginated_ws_federation_provider_list.py
+test/test_pagination.py
+test/test_partial_group.py
+test/test_partial_user.py
+test/test_password_challenge.py
+test/test_password_challenge_response_request.py
+test/test_password_expiry_policy.py
+test/test_password_expiry_policy_request.py
+test/test_password_policy.py
+test/test_password_policy_request.py
+test/test_password_stage.py
+test/test_password_stage_request.py
+test/test_patched_account_lockdown_stage_request.py
+test/test_patched_agent_connector_request.py
+test/test_patched_apple_independent_secure_enclave_request.py
+test/test_patched_application_entitlement_request.py
+test/test_patched_application_request.py
+test/test_patched_authenticator_duo_stage_request.py
+test/test_patched_authenticator_email_stage_request.py
+test/test_patched_authenticator_endpoint_gdtc_stage_request.py
+test/test_patched_authenticator_sms_stage_request.py
+test/test_patched_authenticator_static_stage_request.py
+test/test_patched_authenticator_totp_stage_request.py
+test/test_patched_authenticator_validate_stage_request.py
+test/test_patched_authenticator_web_authn_stage_request.py
+test/test_patched_blueprint_instance_request.py
+test/test_patched_brand_request.py
+test/test_patched_captcha_stage_request.py
+test/test_patched_certificate_key_pair_request.py
+test/test_patched_connection_token_request.py
+test/test_patched_consent_stage_request.py
+test/test_patched_deny_stage_request.py
+test/test_patched_device_access_group_request.py
+test/test_patched_device_user_binding_request.py
+test/test_patched_docker_service_connection_request.py
+test/test_patched_domain_request.py
+test/test_patched_dummy_policy_request.py
+test/test_patched_dummy_stage_request.py
+test/test_patched_duo_device_request.py
+test/test_patched_email_device_request.py
+test/test_patched_email_stage_request.py
+test/test_patched_endpoint_device_request.py
+test/test_patched_endpoint_request.py
+test/test_patched_endpoint_stage_request.py
+test/test_patched_enrollment_token_request.py
+test/test_patched_event_matcher_policy_request.py
+test/test_patched_event_request.py
+test/test_patched_expression_policy_request.py
+test/test_patched_fleet_connector_request.py
+test/test_patched_flow_request.py
+test/test_patched_flow_stage_binding_request.py
+test/test_patched_geo_ip_policy_request.py
+test/test_patched_google_chrome_connector_request.py
+test/test_patched_google_endpoint_device_request.py
+test/test_patched_google_workspace_provider_mapping_request.py
+test/test_patched_google_workspace_provider_request.py
+test/test_patched_group_kerberos_source_connection_request.py
+test/test_patched_group_ldap_source_connection_request.py
+test/test_patched_group_o_auth_source_connection_request.py
+test/test_patched_group_plex_source_connection_request.py
+test/test_patched_group_request.py
+test/test_patched_group_saml_source_connection_request.py
+test/test_patched_group_source_connection_request.py
+test/test_patched_group_telegram_source_connection_request.py
+test/test_patched_identification_stage_request.py
+test/test_patched_initial_permissions_request.py
+test/test_patched_invitation_request.py
+test/test_patched_invitation_stage_request.py
+test/test_patched_kerberos_source_property_mapping_request.py
+test/test_patched_kerberos_source_request.py
+test/test_patched_kubernetes_service_connection_request.py
+test/test_patched_ldap_provider_request.py
+test/test_patched_ldap_source_property_mapping_request.py
+test/test_patched_ldap_source_request.py
+test/test_patched_license_request.py
+test/test_patched_lifecycle_rule_request.py
+test/test_patched_microsoft_entra_provider_mapping_request.py
+test/test_patched_microsoft_entra_provider_request.py
+test/test_patched_mutual_tls_stage_request.py
+test/test_patched_notification_request.py
+test/test_patched_notification_rule_request.py
+test/test_patched_notification_transport_request.py
+test/test_patched_notification_webhook_mapping_request.py
+test/test_patched_o_auth2_provider_request.py
+test/test_patched_o_auth_source_property_mapping_request.py
+test/test_patched_o_auth_source_request.py
+test/test_patched_outpost_request.py
+test/test_patched_password_expiry_policy_request.py
+test/test_patched_password_policy_request.py
+test/test_patched_password_stage_request.py
+test/test_patched_permission_assign_request.py
+test/test_patched_plex_source_property_mapping_request.py
+test/test_patched_plex_source_request.py
+test/test_patched_policy_binding_request.py
+test/test_patched_prompt_request.py
+test/test_patched_prompt_stage_request.py
+test/test_patched_proxy_provider_request.py
+test/test_patched_rac_property_mapping_request.py
+test/test_patched_rac_provider_request.py
+test/test_patched_radius_provider_property_mapping_request.py
+test/test_patched_radius_provider_request.py
+test/test_patched_redirect_stage_request.py
+test/test_patched_reputation_policy_request.py
+test/test_patched_role_request.py
+test/test_patched_saml_property_mapping_request.py
+test/test_patched_saml_provider_request.py
+test/test_patched_saml_source_property_mapping_request.py
+test/test_patched_saml_source_request.py
+test/test_patched_schedule_request.py
+test/test_patched_scim_mapping_request.py
+test/test_patched_scim_provider_request.py
+test/test_patched_scim_source_group_request.py
+test/test_patched_scim_source_property_mapping_request.py
+test/test_patched_scim_source_request.py
+test/test_patched_scim_source_user_request.py
+test/test_patched_scope_mapping_request.py
+test/test_patched_settings_request.py
+test/test_patched_settings_request_flags.py
+test/test_patched_sms_device_request.py
+test/test_patched_source_stage_request.py
+test/test_patched_ssf_provider_request.py
+test/test_patched_static_device_request.py
+test/test_patched_telegram_source_property_mapping_request.py
+test/test_patched_telegram_source_request.py
+test/test_patched_tenant_request.py
+test/test_patched_token_request.py
+test/test_patched_totp_device_request.py
+test/test_patched_unique_password_policy_request.py
+test/test_patched_user_delete_stage_request.py
+test/test_patched_user_kerberos_source_connection_request.py
+test/test_patched_user_ldap_source_connection_request.py
+test/test_patched_user_login_stage_request.py
+test/test_patched_user_logout_stage_request.py
+test/test_patched_user_o_auth_source_connection_request.py
+test/test_patched_user_plex_source_connection_request.py
+test/test_patched_user_request.py
+test/test_patched_user_saml_source_connection_request.py
+test/test_patched_user_source_connection_request.py
+test/test_patched_user_telegram_source_connection_request.py
+test/test_patched_user_write_stage_request.py
+test/test_patched_web_authn_device_request.py
+test/test_patched_ws_federation_provider_request.py
+test/test_permission.py
+test/test_permission_assign_request.py
+test/test_permission_assign_result.py
+test/test_pkce_method_enum.py
+test/test_plex_authentication_challenge.py
+test/test_plex_authentication_challenge_response_request.py
+test/test_plex_source.py
+test/test_plex_source_property_mapping.py
+test/test_plex_source_property_mapping_request.py
+test/test_plex_source_request.py
+test/test_plex_token_redeem_request.py
+test/test_policies_api.py
+test/test_policy.py
+test/test_policy_binding.py
+test/test_policy_binding_request.py
+test/test_policy_engine_mode.py
+test/test_policy_test_request.py
+test/test_policy_test_result.py
+test/test_process.py
+test/test_process_request.py
+test/test_prompt.py
+test/test_prompt_challenge.py
+test/test_prompt_challenge_response_request.py
+test/test_prompt_choice.py
+test/test_prompt_request.py
+test/test_prompt_stage.py
+test/test_prompt_stage_request.py
+test/test_prompt_type_enum.py
+test/test_property_mapping.py
+test/test_property_mapping_preview.py
+test/test_property_mapping_test_request.py
+test/test_property_mapping_test_result.py
+test/test_propertymappings_api.py
+test/test_protocol_enum.py
+test/test_provider.py
+test/test_provider_enum.py
+test/test_provider_model_enum.py
+test/test_provider_type_enum.py
+test/test_providers_api.py
+test/test_proxy_mode.py
+test/test_proxy_outpost_config.py
+test/test_proxy_provider.py
+test/test_proxy_provider_request.py
+test/test_rac_api.py
+test/test_rac_property_mapping.py
+test/test_rac_property_mapping_request.py
+test/test_rac_provider.py
+test/test_rac_provider_request.py
+test/test_radius_check_access.py
+test/test_radius_outpost_config.py
+test/test_radius_provider.py
+test/test_radius_provider_property_mapping.py
+test/test_radius_provider_property_mapping_request.py
+test/test_radius_provider_request.py
+test/test_rbac_api.py
+test/test_redirect_challenge.py
+test/test_redirect_challenge_response_request.py
+test/test_redirect_stage.py
+test/test_redirect_stage_mode_enum.py
+test/test_redirect_stage_request.py
+test/test_redirect_uri.py
+test/test_redirect_uri_request.py
+test/test_redirect_uri_type_enum.py
+test/test_related_group.py
+test/test_related_rule.py
+test/test_reports_api.py
+test/test_reputation.py
+test/test_reputation_policy.py
+test/test_reputation_policy_request.py
+test/test_review.py
+test/test_review_request.py
+test/test_reviewer_group.py
+test/test_reviewer_user.py
+test/test_role.py
+test/test_role_assigned_object_permission.py
+test/test_role_model_permission.py
+test/test_role_object_permission.py
+test/test_role_request.py
+test/test_root_api.py
+test/test_saml_bindings_enum.py
+test/test_saml_logout_methods.py
+test/test_saml_metadata.py
+test/test_saml_name_id_policy_enum.py
+test/test_saml_property_mapping.py
+test/test_saml_property_mapping_request.py
+test/test_saml_provider.py
+test/test_saml_provider_request.py
+test/test_saml_source.py
+test/test_saml_source_property_mapping.py
+test/test_saml_source_property_mapping_request.py
+test/test_saml_source_request.py
+test/test_schedule.py
+test/test_schedule_request.py
+test/test_schema_api.py
+test/test_scim_authentication_mode_enum.py
+test/test_scim_mapping.py
+test/test_scim_mapping_request.py
+test/test_scim_provider.py
+test/test_scim_provider_group.py
+test/test_scim_provider_group_request.py
+test/test_scim_provider_request.py
+test/test_scim_provider_user.py
+test/test_scim_provider_user_request.py
+test/test_scim_source.py
+test/test_scim_source_group.py
+test/test_scim_source_group_request.py
+test/test_scim_source_property_mapping.py
+test/test_scim_source_property_mapping_request.py
+test/test_scim_source_request.py
+test/test_scim_source_user.py
+test/test_scim_source_user_request.py
+test/test_scope_mapping.py
+test/test_scope_mapping_request.py
+test/test_selectable_stage.py
+test/test_service_connection.py
+test/test_service_connection_state.py
+test/test_session_end_challenge.py
+test/test_session_user.py
+test/test_settings.py
+test/test_settings_request.py
+test/test_severity_enum.py
+test/test_shell_challenge.py
+test/test_signature_algorithm_enum.py
+test/test_sms_device.py
+test/test_sms_device_request.py
+test/test_software.py
+test/test_software_request.py
+test/test_source.py
+test/test_source_stage.py
+test/test_source_stage_request.py
+test/test_source_type.py
+test/test_sources_api.py
+test/test_ssf_api.py
+test/test_ssf_provider.py
+test/test_ssf_provider_request.py
+test/test_ssf_stream.py
+test/test_ssf_stream_status_enum.py
+test/test_stage.py
+test/test_stage_mode_enum.py
+test/test_stage_prompt.py
+test/test_stages_api.py
+test/test_static_device.py
+test/test_static_device_request.py
+test/test_static_device_token.py
+test/test_sub_mode_enum.py
+test/test_sync_object_model_enum.py
+test/test_sync_object_request.py
+test/test_sync_object_result.py
+test/test_sync_outgoing_trigger_mode_enum.py
+test/test_sync_status.py
+test/test_system_info.py
+test/test_system_info_runtime.py
+test/test_task.py
+test/test_task_aggregated_status_enum.py
+test/test_task_status_enum.py
+test/test_tasks_api.py
+test/test_telegram_auth_request.py
+test/test_telegram_challenge_response_request.py
+test/test_telegram_login_challenge.py
+test/test_telegram_source.py
+test/test_telegram_source_property_mapping.py
+test/test_telegram_source_property_mapping_request.py
+test/test_telegram_source_request.py
+test/test_tenant.py
+test/test_tenant_admin_group_request_request.py
+test/test_tenant_recovery_key_request_request.py
+test/test_tenant_recovery_key_response.py
+test/test_tenant_request.py
+test/test_tenants_api.py
+test/test_themed_urls.py
+test/test_token.py
+test/test_token_model.py
+test/test_token_request.py
+test/test_token_set_key_request.py
+test/test_token_view.py
+test/test_totp_device.py
+test/test_totp_device_request.py
+test/test_transaction_application_request.py
+test/test_transaction_application_response.py
+test/test_transaction_policy_binding_request.py
+test/test_transport_mode_enum.py
+test/test_type_create.py
+test/test_ui_theme_enum.py
+test/test_unique_password_policy.py
+test/test_unique_password_policy_request.py
+test/test_usage_enum.py
+test/test_used_by.py
+test/test_used_by_action_enum.py
+test/test_user.py
+test/test_user_account_lockdown_request.py
+test/test_user_account_request.py
+test/test_user_account_serializer_for_role_request.py
+test/test_user_attribute_enum.py
+test/test_user_consent.py
+test/test_user_creation_mode_enum.py
+test/test_user_delete_stage.py
+test/test_user_delete_stage_request.py
+test/test_user_fields_enum.py
+test/test_user_kerberos_source_connection.py
+test/test_user_kerberos_source_connection_request.py
+test/test_user_ldap_source_connection.py
+test/test_user_ldap_source_connection_request.py
+test/test_user_login_challenge.py
+test/test_user_login_challenge_response_request.py
+test/test_user_login_stage.py
+test/test_user_login_stage_request.py
+test/test_user_logout_stage.py
+test/test_user_logout_stage_request.py
+test/test_user_matching_mode_enum.py
+test/test_user_o_auth_source_connection.py
+test/test_user_o_auth_source_connection_request.py
+test/test_user_password_hash_set_request.py
+test/test_user_password_set_request.py
+test/test_user_path.py
+test/test_user_plex_source_connection.py
+test/test_user_plex_source_connection_request.py
+test/test_user_recovery_email_request.py
+test/test_user_recovery_link_request.py
+test/test_user_request.py
+test/test_user_saml_source_connection.py
+test/test_user_saml_source_connection_request.py
+test/test_user_self.py
+test/test_user_self_groups.py
+test/test_user_self_roles.py
+test/test_user_service_account_request.py
+test/test_user_service_account_response.py
+test/test_user_setting.py
+test/test_user_source_connection.py
+test/test_user_source_connection_request.py
+test/test_user_telegram_source_connection.py
+test/test_user_telegram_source_connection_request.py
+test/test_user_type_enum.py
+test/test_user_verification_enum.py
+test/test_user_write_stage.py
+test/test_user_write_stage_request.py
+test/test_validation_error.py
+test/test_vendor_enum.py
+test/test_version.py
+test/test_version_history.py
+test/test_web_authn_device.py
+test/test_web_authn_device_request.py
+test/test_web_authn_device_type.py
+test/test_web_authn_hint_enum.py
+test/test_worker.py
+test/test_ws_federation_provider.py
+test/test_ws_federation_provider_request.py
+tox.ini
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
new file mode 100644
index 000000000..696eaac5c
--- /dev/null
+++ b/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.22.0
diff --git a/README.md b/README.md
index 75f480d80..b4618d052 100644
--- a/README.md
+++ b/README.md
@@ -11,4 +11,2139 @@
This repo contains a generated API client to talk with authentik's API from Python.
-Checkout a specific tag corresponding to the authentik version you want to use this API client with to see both the code and documentation.
+## Overview
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2026.5.0-rc1
+- Package version: 2026.5.0-rc1
+- Generator version: 7.22.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.10+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import authentik_client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import authentik_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import authentik_client
+from authentik_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api/v3
+# See configuration.py for a list of all supported configuration parameters.
+configuration = authentik_client.Configuration(
+ host = "/api/v3"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization: authentik
+configuration = authentik_client.Configuration(
+ access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with authentik_client.ApiClient(configuration) as api_client:
+ # Create an instance of the API class
+ api_instance = authentik_client.AdminApi(api_client)
+
+ try:
+ api_response = api_instance.admin_apps_list()
+ print("The response of AdminApi->admin_apps_list:\n")
+ pprint(api_response)
+ except ApiException as e:
+ print("Exception when calling AdminApi->admin_apps_list: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to */api/v3*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AdminApi* | [**admin_apps_list**](docs/AdminApi.md#admin_apps_list) | **GET** /admin/apps/ |
+*AdminApi* | [**admin_file_create**](docs/AdminApi.md#admin_file_create) | **POST** /admin/file/ |
+*AdminApi* | [**admin_file_destroy**](docs/AdminApi.md#admin_file_destroy) | **DELETE** /admin/file/ |
+*AdminApi* | [**admin_file_list**](docs/AdminApi.md#admin_file_list) | **GET** /admin/file/ |
+*AdminApi* | [**admin_file_used_by_list**](docs/AdminApi.md#admin_file_used_by_list) | **GET** /admin/file/used_by/ |
+*AdminApi* | [**admin_models_list**](docs/AdminApi.md#admin_models_list) | **GET** /admin/models/ |
+*AdminApi* | [**admin_settings_partial_update**](docs/AdminApi.md#admin_settings_partial_update) | **PATCH** /admin/settings/ |
+*AdminApi* | [**admin_settings_retrieve**](docs/AdminApi.md#admin_settings_retrieve) | **GET** /admin/settings/ |
+*AdminApi* | [**admin_settings_update**](docs/AdminApi.md#admin_settings_update) | **PUT** /admin/settings/ |
+*AdminApi* | [**admin_system_create**](docs/AdminApi.md#admin_system_create) | **POST** /admin/system/ |
+*AdminApi* | [**admin_system_retrieve**](docs/AdminApi.md#admin_system_retrieve) | **GET** /admin/system/ |
+*AdminApi* | [**admin_version_history_list**](docs/AdminApi.md#admin_version_history_list) | **GET** /admin/version/history/ |
+*AdminApi* | [**admin_version_history_retrieve**](docs/AdminApi.md#admin_version_history_retrieve) | **GET** /admin/version/history/{id}/ |
+*AdminApi* | [**admin_version_retrieve**](docs/AdminApi.md#admin_version_retrieve) | **GET** /admin/version/ |
+*AuthenticatorsApi* | [**authenticators_admin_all_list**](docs/AuthenticatorsApi.md#authenticators_admin_all_list) | **GET** /authenticators/admin/all/ |
+*AuthenticatorsApi* | [**authenticators_admin_duo_create**](docs/AuthenticatorsApi.md#authenticators_admin_duo_create) | **POST** /authenticators/admin/duo/ |
+*AuthenticatorsApi* | [**authenticators_admin_duo_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_duo_destroy) | **DELETE** /authenticators/admin/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_duo_list**](docs/AuthenticatorsApi.md#authenticators_admin_duo_list) | **GET** /authenticators/admin/duo/ |
+*AuthenticatorsApi* | [**authenticators_admin_duo_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_duo_partial_update) | **PATCH** /authenticators/admin/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_duo_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_duo_retrieve) | **GET** /authenticators/admin/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_duo_update**](docs/AuthenticatorsApi.md#authenticators_admin_duo_update) | **PUT** /authenticators/admin/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_email_create**](docs/AuthenticatorsApi.md#authenticators_admin_email_create) | **POST** /authenticators/admin/email/ |
+*AuthenticatorsApi* | [**authenticators_admin_email_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_email_destroy) | **DELETE** /authenticators/admin/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_email_list**](docs/AuthenticatorsApi.md#authenticators_admin_email_list) | **GET** /authenticators/admin/email/ |
+*AuthenticatorsApi* | [**authenticators_admin_email_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_email_partial_update) | **PATCH** /authenticators/admin/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_email_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_email_retrieve) | **GET** /authenticators/admin/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_email_update**](docs/AuthenticatorsApi.md#authenticators_admin_email_update) | **PUT** /authenticators/admin/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_endpoint_create**](docs/AuthenticatorsApi.md#authenticators_admin_endpoint_create) | **POST** /authenticators/admin/endpoint/ |
+*AuthenticatorsApi* | [**authenticators_admin_endpoint_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_endpoint_destroy) | **DELETE** /authenticators/admin/endpoint/{uuid}/ |
+*AuthenticatorsApi* | [**authenticators_admin_endpoint_list**](docs/AuthenticatorsApi.md#authenticators_admin_endpoint_list) | **GET** /authenticators/admin/endpoint/ |
+*AuthenticatorsApi* | [**authenticators_admin_endpoint_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_endpoint_partial_update) | **PATCH** /authenticators/admin/endpoint/{uuid}/ |
+*AuthenticatorsApi* | [**authenticators_admin_endpoint_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_endpoint_retrieve) | **GET** /authenticators/admin/endpoint/{uuid}/ |
+*AuthenticatorsApi* | [**authenticators_admin_endpoint_update**](docs/AuthenticatorsApi.md#authenticators_admin_endpoint_update) | **PUT** /authenticators/admin/endpoint/{uuid}/ |
+*AuthenticatorsApi* | [**authenticators_admin_sms_create**](docs/AuthenticatorsApi.md#authenticators_admin_sms_create) | **POST** /authenticators/admin/sms/ |
+*AuthenticatorsApi* | [**authenticators_admin_sms_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_sms_destroy) | **DELETE** /authenticators/admin/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_sms_list**](docs/AuthenticatorsApi.md#authenticators_admin_sms_list) | **GET** /authenticators/admin/sms/ |
+*AuthenticatorsApi* | [**authenticators_admin_sms_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_sms_partial_update) | **PATCH** /authenticators/admin/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_sms_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_sms_retrieve) | **GET** /authenticators/admin/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_sms_update**](docs/AuthenticatorsApi.md#authenticators_admin_sms_update) | **PUT** /authenticators/admin/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_static_create**](docs/AuthenticatorsApi.md#authenticators_admin_static_create) | **POST** /authenticators/admin/static/ |
+*AuthenticatorsApi* | [**authenticators_admin_static_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_static_destroy) | **DELETE** /authenticators/admin/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_static_list**](docs/AuthenticatorsApi.md#authenticators_admin_static_list) | **GET** /authenticators/admin/static/ |
+*AuthenticatorsApi* | [**authenticators_admin_static_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_static_partial_update) | **PATCH** /authenticators/admin/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_static_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_static_retrieve) | **GET** /authenticators/admin/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_static_update**](docs/AuthenticatorsApi.md#authenticators_admin_static_update) | **PUT** /authenticators/admin/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_totp_create**](docs/AuthenticatorsApi.md#authenticators_admin_totp_create) | **POST** /authenticators/admin/totp/ |
+*AuthenticatorsApi* | [**authenticators_admin_totp_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_totp_destroy) | **DELETE** /authenticators/admin/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_totp_list**](docs/AuthenticatorsApi.md#authenticators_admin_totp_list) | **GET** /authenticators/admin/totp/ |
+*AuthenticatorsApi* | [**authenticators_admin_totp_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_totp_partial_update) | **PATCH** /authenticators/admin/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_totp_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_totp_retrieve) | **GET** /authenticators/admin/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_totp_update**](docs/AuthenticatorsApi.md#authenticators_admin_totp_update) | **PUT** /authenticators/admin/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_webauthn_create**](docs/AuthenticatorsApi.md#authenticators_admin_webauthn_create) | **POST** /authenticators/admin/webauthn/ |
+*AuthenticatorsApi* | [**authenticators_admin_webauthn_destroy**](docs/AuthenticatorsApi.md#authenticators_admin_webauthn_destroy) | **DELETE** /authenticators/admin/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_webauthn_list**](docs/AuthenticatorsApi.md#authenticators_admin_webauthn_list) | **GET** /authenticators/admin/webauthn/ |
+*AuthenticatorsApi* | [**authenticators_admin_webauthn_partial_update**](docs/AuthenticatorsApi.md#authenticators_admin_webauthn_partial_update) | **PATCH** /authenticators/admin/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_webauthn_retrieve**](docs/AuthenticatorsApi.md#authenticators_admin_webauthn_retrieve) | **GET** /authenticators/admin/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_admin_webauthn_update**](docs/AuthenticatorsApi.md#authenticators_admin_webauthn_update) | **PUT** /authenticators/admin/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_all_list**](docs/AuthenticatorsApi.md#authenticators_all_list) | **GET** /authenticators/all/ |
+*AuthenticatorsApi* | [**authenticators_duo_destroy**](docs/AuthenticatorsApi.md#authenticators_duo_destroy) | **DELETE** /authenticators/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_duo_list**](docs/AuthenticatorsApi.md#authenticators_duo_list) | **GET** /authenticators/duo/ |
+*AuthenticatorsApi* | [**authenticators_duo_partial_update**](docs/AuthenticatorsApi.md#authenticators_duo_partial_update) | **PATCH** /authenticators/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_duo_retrieve**](docs/AuthenticatorsApi.md#authenticators_duo_retrieve) | **GET** /authenticators/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_duo_update**](docs/AuthenticatorsApi.md#authenticators_duo_update) | **PUT** /authenticators/duo/{id}/ |
+*AuthenticatorsApi* | [**authenticators_duo_used_by_list**](docs/AuthenticatorsApi.md#authenticators_duo_used_by_list) | **GET** /authenticators/duo/{id}/used_by/ |
+*AuthenticatorsApi* | [**authenticators_email_destroy**](docs/AuthenticatorsApi.md#authenticators_email_destroy) | **DELETE** /authenticators/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_email_list**](docs/AuthenticatorsApi.md#authenticators_email_list) | **GET** /authenticators/email/ |
+*AuthenticatorsApi* | [**authenticators_email_partial_update**](docs/AuthenticatorsApi.md#authenticators_email_partial_update) | **PATCH** /authenticators/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_email_retrieve**](docs/AuthenticatorsApi.md#authenticators_email_retrieve) | **GET** /authenticators/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_email_update**](docs/AuthenticatorsApi.md#authenticators_email_update) | **PUT** /authenticators/email/{id}/ |
+*AuthenticatorsApi* | [**authenticators_email_used_by_list**](docs/AuthenticatorsApi.md#authenticators_email_used_by_list) | **GET** /authenticators/email/{id}/used_by/ |
+*AuthenticatorsApi* | [**authenticators_endpoint_list**](docs/AuthenticatorsApi.md#authenticators_endpoint_list) | **GET** /authenticators/endpoint/ |
+*AuthenticatorsApi* | [**authenticators_endpoint_retrieve**](docs/AuthenticatorsApi.md#authenticators_endpoint_retrieve) | **GET** /authenticators/endpoint/{uuid}/ |
+*AuthenticatorsApi* | [**authenticators_endpoint_used_by_list**](docs/AuthenticatorsApi.md#authenticators_endpoint_used_by_list) | **GET** /authenticators/endpoint/{uuid}/used_by/ |
+*AuthenticatorsApi* | [**authenticators_sms_destroy**](docs/AuthenticatorsApi.md#authenticators_sms_destroy) | **DELETE** /authenticators/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_sms_list**](docs/AuthenticatorsApi.md#authenticators_sms_list) | **GET** /authenticators/sms/ |
+*AuthenticatorsApi* | [**authenticators_sms_partial_update**](docs/AuthenticatorsApi.md#authenticators_sms_partial_update) | **PATCH** /authenticators/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_sms_retrieve**](docs/AuthenticatorsApi.md#authenticators_sms_retrieve) | **GET** /authenticators/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_sms_update**](docs/AuthenticatorsApi.md#authenticators_sms_update) | **PUT** /authenticators/sms/{id}/ |
+*AuthenticatorsApi* | [**authenticators_sms_used_by_list**](docs/AuthenticatorsApi.md#authenticators_sms_used_by_list) | **GET** /authenticators/sms/{id}/used_by/ |
+*AuthenticatorsApi* | [**authenticators_static_destroy**](docs/AuthenticatorsApi.md#authenticators_static_destroy) | **DELETE** /authenticators/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_static_list**](docs/AuthenticatorsApi.md#authenticators_static_list) | **GET** /authenticators/static/ |
+*AuthenticatorsApi* | [**authenticators_static_partial_update**](docs/AuthenticatorsApi.md#authenticators_static_partial_update) | **PATCH** /authenticators/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_static_retrieve**](docs/AuthenticatorsApi.md#authenticators_static_retrieve) | **GET** /authenticators/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_static_update**](docs/AuthenticatorsApi.md#authenticators_static_update) | **PUT** /authenticators/static/{id}/ |
+*AuthenticatorsApi* | [**authenticators_static_used_by_list**](docs/AuthenticatorsApi.md#authenticators_static_used_by_list) | **GET** /authenticators/static/{id}/used_by/ |
+*AuthenticatorsApi* | [**authenticators_totp_destroy**](docs/AuthenticatorsApi.md#authenticators_totp_destroy) | **DELETE** /authenticators/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_totp_list**](docs/AuthenticatorsApi.md#authenticators_totp_list) | **GET** /authenticators/totp/ |
+*AuthenticatorsApi* | [**authenticators_totp_partial_update**](docs/AuthenticatorsApi.md#authenticators_totp_partial_update) | **PATCH** /authenticators/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_totp_retrieve**](docs/AuthenticatorsApi.md#authenticators_totp_retrieve) | **GET** /authenticators/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_totp_update**](docs/AuthenticatorsApi.md#authenticators_totp_update) | **PUT** /authenticators/totp/{id}/ |
+*AuthenticatorsApi* | [**authenticators_totp_used_by_list**](docs/AuthenticatorsApi.md#authenticators_totp_used_by_list) | **GET** /authenticators/totp/{id}/used_by/ |
+*AuthenticatorsApi* | [**authenticators_webauthn_destroy**](docs/AuthenticatorsApi.md#authenticators_webauthn_destroy) | **DELETE** /authenticators/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_webauthn_list**](docs/AuthenticatorsApi.md#authenticators_webauthn_list) | **GET** /authenticators/webauthn/ |
+*AuthenticatorsApi* | [**authenticators_webauthn_partial_update**](docs/AuthenticatorsApi.md#authenticators_webauthn_partial_update) | **PATCH** /authenticators/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_webauthn_retrieve**](docs/AuthenticatorsApi.md#authenticators_webauthn_retrieve) | **GET** /authenticators/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_webauthn_update**](docs/AuthenticatorsApi.md#authenticators_webauthn_update) | **PUT** /authenticators/webauthn/{id}/ |
+*AuthenticatorsApi* | [**authenticators_webauthn_used_by_list**](docs/AuthenticatorsApi.md#authenticators_webauthn_used_by_list) | **GET** /authenticators/webauthn/{id}/used_by/ |
+*CoreApi* | [**core_application_entitlements_create**](docs/CoreApi.md#core_application_entitlements_create) | **POST** /core/application_entitlements/ |
+*CoreApi* | [**core_application_entitlements_destroy**](docs/CoreApi.md#core_application_entitlements_destroy) | **DELETE** /core/application_entitlements/{pbm_uuid}/ |
+*CoreApi* | [**core_application_entitlements_list**](docs/CoreApi.md#core_application_entitlements_list) | **GET** /core/application_entitlements/ |
+*CoreApi* | [**core_application_entitlements_partial_update**](docs/CoreApi.md#core_application_entitlements_partial_update) | **PATCH** /core/application_entitlements/{pbm_uuid}/ |
+*CoreApi* | [**core_application_entitlements_retrieve**](docs/CoreApi.md#core_application_entitlements_retrieve) | **GET** /core/application_entitlements/{pbm_uuid}/ |
+*CoreApi* | [**core_application_entitlements_update**](docs/CoreApi.md#core_application_entitlements_update) | **PUT** /core/application_entitlements/{pbm_uuid}/ |
+*CoreApi* | [**core_application_entitlements_used_by_list**](docs/CoreApi.md#core_application_entitlements_used_by_list) | **GET** /core/application_entitlements/{pbm_uuid}/used_by/ |
+*CoreApi* | [**core_applications_check_access_retrieve**](docs/CoreApi.md#core_applications_check_access_retrieve) | **GET** /core/applications/{slug}/check_access/ |
+*CoreApi* | [**core_applications_create**](docs/CoreApi.md#core_applications_create) | **POST** /core/applications/ |
+*CoreApi* | [**core_applications_destroy**](docs/CoreApi.md#core_applications_destroy) | **DELETE** /core/applications/{slug}/ |
+*CoreApi* | [**core_applications_list**](docs/CoreApi.md#core_applications_list) | **GET** /core/applications/ |
+*CoreApi* | [**core_applications_partial_update**](docs/CoreApi.md#core_applications_partial_update) | **PATCH** /core/applications/{slug}/ |
+*CoreApi* | [**core_applications_retrieve**](docs/CoreApi.md#core_applications_retrieve) | **GET** /core/applications/{slug}/ |
+*CoreApi* | [**core_applications_update**](docs/CoreApi.md#core_applications_update) | **PUT** /core/applications/{slug}/ |
+*CoreApi* | [**core_applications_used_by_list**](docs/CoreApi.md#core_applications_used_by_list) | **GET** /core/applications/{slug}/used_by/ |
+*CoreApi* | [**core_authenticated_sessions_bulk_delete_destroy**](docs/CoreApi.md#core_authenticated_sessions_bulk_delete_destroy) | **DELETE** /core/authenticated_sessions/bulk_delete/ |
+*CoreApi* | [**core_authenticated_sessions_destroy**](docs/CoreApi.md#core_authenticated_sessions_destroy) | **DELETE** /core/authenticated_sessions/{uuid}/ |
+*CoreApi* | [**core_authenticated_sessions_list**](docs/CoreApi.md#core_authenticated_sessions_list) | **GET** /core/authenticated_sessions/ |
+*CoreApi* | [**core_authenticated_sessions_retrieve**](docs/CoreApi.md#core_authenticated_sessions_retrieve) | **GET** /core/authenticated_sessions/{uuid}/ |
+*CoreApi* | [**core_authenticated_sessions_used_by_list**](docs/CoreApi.md#core_authenticated_sessions_used_by_list) | **GET** /core/authenticated_sessions/{uuid}/used_by/ |
+*CoreApi* | [**core_brands_create**](docs/CoreApi.md#core_brands_create) | **POST** /core/brands/ |
+*CoreApi* | [**core_brands_current_retrieve**](docs/CoreApi.md#core_brands_current_retrieve) | **GET** /core/brands/current/ |
+*CoreApi* | [**core_brands_destroy**](docs/CoreApi.md#core_brands_destroy) | **DELETE** /core/brands/{brand_uuid}/ |
+*CoreApi* | [**core_brands_list**](docs/CoreApi.md#core_brands_list) | **GET** /core/brands/ |
+*CoreApi* | [**core_brands_partial_update**](docs/CoreApi.md#core_brands_partial_update) | **PATCH** /core/brands/{brand_uuid}/ |
+*CoreApi* | [**core_brands_retrieve**](docs/CoreApi.md#core_brands_retrieve) | **GET** /core/brands/{brand_uuid}/ |
+*CoreApi* | [**core_brands_update**](docs/CoreApi.md#core_brands_update) | **PUT** /core/brands/{brand_uuid}/ |
+*CoreApi* | [**core_brands_used_by_list**](docs/CoreApi.md#core_brands_used_by_list) | **GET** /core/brands/{brand_uuid}/used_by/ |
+*CoreApi* | [**core_groups_add_user_create**](docs/CoreApi.md#core_groups_add_user_create) | **POST** /core/groups/{group_uuid}/add_user/ |
+*CoreApi* | [**core_groups_create**](docs/CoreApi.md#core_groups_create) | **POST** /core/groups/ |
+*CoreApi* | [**core_groups_destroy**](docs/CoreApi.md#core_groups_destroy) | **DELETE** /core/groups/{group_uuid}/ |
+*CoreApi* | [**core_groups_list**](docs/CoreApi.md#core_groups_list) | **GET** /core/groups/ |
+*CoreApi* | [**core_groups_partial_update**](docs/CoreApi.md#core_groups_partial_update) | **PATCH** /core/groups/{group_uuid}/ |
+*CoreApi* | [**core_groups_remove_user_create**](docs/CoreApi.md#core_groups_remove_user_create) | **POST** /core/groups/{group_uuid}/remove_user/ |
+*CoreApi* | [**core_groups_retrieve**](docs/CoreApi.md#core_groups_retrieve) | **GET** /core/groups/{group_uuid}/ |
+*CoreApi* | [**core_groups_update**](docs/CoreApi.md#core_groups_update) | **PUT** /core/groups/{group_uuid}/ |
+*CoreApi* | [**core_groups_used_by_list**](docs/CoreApi.md#core_groups_used_by_list) | **GET** /core/groups/{group_uuid}/used_by/ |
+*CoreApi* | [**core_tokens_create**](docs/CoreApi.md#core_tokens_create) | **POST** /core/tokens/ |
+*CoreApi* | [**core_tokens_destroy**](docs/CoreApi.md#core_tokens_destroy) | **DELETE** /core/tokens/{identifier}/ |
+*CoreApi* | [**core_tokens_list**](docs/CoreApi.md#core_tokens_list) | **GET** /core/tokens/ |
+*CoreApi* | [**core_tokens_partial_update**](docs/CoreApi.md#core_tokens_partial_update) | **PATCH** /core/tokens/{identifier}/ |
+*CoreApi* | [**core_tokens_retrieve**](docs/CoreApi.md#core_tokens_retrieve) | **GET** /core/tokens/{identifier}/ |
+*CoreApi* | [**core_tokens_set_key_create**](docs/CoreApi.md#core_tokens_set_key_create) | **POST** /core/tokens/{identifier}/set_key/ |
+*CoreApi* | [**core_tokens_update**](docs/CoreApi.md#core_tokens_update) | **PUT** /core/tokens/{identifier}/ |
+*CoreApi* | [**core_tokens_used_by_list**](docs/CoreApi.md#core_tokens_used_by_list) | **GET** /core/tokens/{identifier}/used_by/ |
+*CoreApi* | [**core_tokens_view_key_retrieve**](docs/CoreApi.md#core_tokens_view_key_retrieve) | **GET** /core/tokens/{identifier}/view_key/ |
+*CoreApi* | [**core_transactional_applications_update**](docs/CoreApi.md#core_transactional_applications_update) | **PUT** /core/transactional/applications/ |
+*CoreApi* | [**core_user_consent_destroy**](docs/CoreApi.md#core_user_consent_destroy) | **DELETE** /core/user_consent/{id}/ |
+*CoreApi* | [**core_user_consent_list**](docs/CoreApi.md#core_user_consent_list) | **GET** /core/user_consent/ |
+*CoreApi* | [**core_user_consent_retrieve**](docs/CoreApi.md#core_user_consent_retrieve) | **GET** /core/user_consent/{id}/ |
+*CoreApi* | [**core_user_consent_used_by_list**](docs/CoreApi.md#core_user_consent_used_by_list) | **GET** /core/user_consent/{id}/used_by/ |
+*CoreApi* | [**core_users_account_lockdown_create**](docs/CoreApi.md#core_users_account_lockdown_create) | **POST** /core/users/account_lockdown/ |
+*CoreApi* | [**core_users_create**](docs/CoreApi.md#core_users_create) | **POST** /core/users/ |
+*CoreApi* | [**core_users_destroy**](docs/CoreApi.md#core_users_destroy) | **DELETE** /core/users/{id}/ |
+*CoreApi* | [**core_users_export_create**](docs/CoreApi.md#core_users_export_create) | **POST** /core/users/export/ |
+*CoreApi* | [**core_users_impersonate_create**](docs/CoreApi.md#core_users_impersonate_create) | **POST** /core/users/{id}/impersonate/ |
+*CoreApi* | [**core_users_impersonate_end_retrieve**](docs/CoreApi.md#core_users_impersonate_end_retrieve) | **GET** /core/users/impersonate_end/ |
+*CoreApi* | [**core_users_list**](docs/CoreApi.md#core_users_list) | **GET** /core/users/ |
+*CoreApi* | [**core_users_me_retrieve**](docs/CoreApi.md#core_users_me_retrieve) | **GET** /core/users/me/ |
+*CoreApi* | [**core_users_partial_update**](docs/CoreApi.md#core_users_partial_update) | **PATCH** /core/users/{id}/ |
+*CoreApi* | [**core_users_paths_retrieve**](docs/CoreApi.md#core_users_paths_retrieve) | **GET** /core/users/paths/ |
+*CoreApi* | [**core_users_recovery_create**](docs/CoreApi.md#core_users_recovery_create) | **POST** /core/users/{id}/recovery/ |
+*CoreApi* | [**core_users_recovery_email_create**](docs/CoreApi.md#core_users_recovery_email_create) | **POST** /core/users/{id}/recovery_email/ |
+*CoreApi* | [**core_users_retrieve**](docs/CoreApi.md#core_users_retrieve) | **GET** /core/users/{id}/ |
+*CoreApi* | [**core_users_service_account_create**](docs/CoreApi.md#core_users_service_account_create) | **POST** /core/users/service_account/ |
+*CoreApi* | [**core_users_set_password_create**](docs/CoreApi.md#core_users_set_password_create) | **POST** /core/users/{id}/set_password/ |
+*CoreApi* | [**core_users_set_password_hash_create**](docs/CoreApi.md#core_users_set_password_hash_create) | **POST** /core/users/{id}/set_password_hash/ |
+*CoreApi* | [**core_users_update**](docs/CoreApi.md#core_users_update) | **PUT** /core/users/{id}/ |
+*CoreApi* | [**core_users_used_by_list**](docs/CoreApi.md#core_users_used_by_list) | **GET** /core/users/{id}/used_by/ |
+*CryptoApi* | [**crypto_certificatekeypairs_create**](docs/CryptoApi.md#crypto_certificatekeypairs_create) | **POST** /crypto/certificatekeypairs/ |
+*CryptoApi* | [**crypto_certificatekeypairs_destroy**](docs/CryptoApi.md#crypto_certificatekeypairs_destroy) | **DELETE** /crypto/certificatekeypairs/{kp_uuid}/ |
+*CryptoApi* | [**crypto_certificatekeypairs_generate_create**](docs/CryptoApi.md#crypto_certificatekeypairs_generate_create) | **POST** /crypto/certificatekeypairs/generate/ |
+*CryptoApi* | [**crypto_certificatekeypairs_list**](docs/CryptoApi.md#crypto_certificatekeypairs_list) | **GET** /crypto/certificatekeypairs/ |
+*CryptoApi* | [**crypto_certificatekeypairs_partial_update**](docs/CryptoApi.md#crypto_certificatekeypairs_partial_update) | **PATCH** /crypto/certificatekeypairs/{kp_uuid}/ |
+*CryptoApi* | [**crypto_certificatekeypairs_retrieve**](docs/CryptoApi.md#crypto_certificatekeypairs_retrieve) | **GET** /crypto/certificatekeypairs/{kp_uuid}/ |
+*CryptoApi* | [**crypto_certificatekeypairs_update**](docs/CryptoApi.md#crypto_certificatekeypairs_update) | **PUT** /crypto/certificatekeypairs/{kp_uuid}/ |
+*CryptoApi* | [**crypto_certificatekeypairs_used_by_list**](docs/CryptoApi.md#crypto_certificatekeypairs_used_by_list) | **GET** /crypto/certificatekeypairs/{kp_uuid}/used_by/ |
+*CryptoApi* | [**crypto_certificatekeypairs_view_certificate_retrieve**](docs/CryptoApi.md#crypto_certificatekeypairs_view_certificate_retrieve) | **GET** /crypto/certificatekeypairs/{kp_uuid}/view_certificate/ |
+*CryptoApi* | [**crypto_certificatekeypairs_view_private_key_retrieve**](docs/CryptoApi.md#crypto_certificatekeypairs_view_private_key_retrieve) | **GET** /crypto/certificatekeypairs/{kp_uuid}/view_private_key/ |
+*EndpointsApi* | [**endpoints_agents_connectors_agent_config_retrieve**](docs/EndpointsApi.md#endpoints_agents_connectors_agent_config_retrieve) | **GET** /endpoints/agents/connectors/agent_config/ |
+*EndpointsApi* | [**endpoints_agents_connectors_auth_fed_create**](docs/EndpointsApi.md#endpoints_agents_connectors_auth_fed_create) | **POST** /endpoints/agents/connectors/auth_fed/ |
+*EndpointsApi* | [**endpoints_agents_connectors_auth_ia_create**](docs/EndpointsApi.md#endpoints_agents_connectors_auth_ia_create) | **POST** /endpoints/agents/connectors/auth_ia/ |
+*EndpointsApi* | [**endpoints_agents_connectors_check_in_create**](docs/EndpointsApi.md#endpoints_agents_connectors_check_in_create) | **POST** /endpoints/agents/connectors/check_in/ |
+*EndpointsApi* | [**endpoints_agents_connectors_create**](docs/EndpointsApi.md#endpoints_agents_connectors_create) | **POST** /endpoints/agents/connectors/ |
+*EndpointsApi* | [**endpoints_agents_connectors_destroy**](docs/EndpointsApi.md#endpoints_agents_connectors_destroy) | **DELETE** /endpoints/agents/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_connectors_enroll_create**](docs/EndpointsApi.md#endpoints_agents_connectors_enroll_create) | **POST** /endpoints/agents/connectors/enroll/ |
+*EndpointsApi* | [**endpoints_agents_connectors_list**](docs/EndpointsApi.md#endpoints_agents_connectors_list) | **GET** /endpoints/agents/connectors/ |
+*EndpointsApi* | [**endpoints_agents_connectors_mdm_config_create**](docs/EndpointsApi.md#endpoints_agents_connectors_mdm_config_create) | **POST** /endpoints/agents/connectors/{connector_uuid}/mdm_config/ |
+*EndpointsApi* | [**endpoints_agents_connectors_partial_update**](docs/EndpointsApi.md#endpoints_agents_connectors_partial_update) | **PATCH** /endpoints/agents/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_connectors_retrieve**](docs/EndpointsApi.md#endpoints_agents_connectors_retrieve) | **GET** /endpoints/agents/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_connectors_update**](docs/EndpointsApi.md#endpoints_agents_connectors_update) | **PUT** /endpoints/agents/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_connectors_used_by_list**](docs/EndpointsApi.md#endpoints_agents_connectors_used_by_list) | **GET** /endpoints/agents/connectors/{connector_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_create**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_create) | **POST** /endpoints/agents/enrollment_tokens/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_destroy**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_destroy) | **DELETE** /endpoints/agents/enrollment_tokens/{token_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_list**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_list) | **GET** /endpoints/agents/enrollment_tokens/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_partial_update**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_partial_update) | **PATCH** /endpoints/agents/enrollment_tokens/{token_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_retrieve**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_retrieve) | **GET** /endpoints/agents/enrollment_tokens/{token_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_update**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_update) | **PUT** /endpoints/agents/enrollment_tokens/{token_uuid}/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_used_by_list**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_used_by_list) | **GET** /endpoints/agents/enrollment_tokens/{token_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_agents_enrollment_tokens_view_key_retrieve**](docs/EndpointsApi.md#endpoints_agents_enrollment_tokens_view_key_retrieve) | **GET** /endpoints/agents/enrollment_tokens/{token_uuid}/view_key/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_create**](docs/EndpointsApi.md#endpoints_agents_psso_ise_create) | **POST** /endpoints/agents/psso/ise/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_destroy**](docs/EndpointsApi.md#endpoints_agents_psso_ise_destroy) | **DELETE** /endpoints/agents/psso/ise/{uuid}/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_list**](docs/EndpointsApi.md#endpoints_agents_psso_ise_list) | **GET** /endpoints/agents/psso/ise/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_partial_update**](docs/EndpointsApi.md#endpoints_agents_psso_ise_partial_update) | **PATCH** /endpoints/agents/psso/ise/{uuid}/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_retrieve**](docs/EndpointsApi.md#endpoints_agents_psso_ise_retrieve) | **GET** /endpoints/agents/psso/ise/{uuid}/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_update**](docs/EndpointsApi.md#endpoints_agents_psso_ise_update) | **PUT** /endpoints/agents/psso/ise/{uuid}/ |
+*EndpointsApi* | [**endpoints_agents_psso_ise_used_by_list**](docs/EndpointsApi.md#endpoints_agents_psso_ise_used_by_list) | **GET** /endpoints/agents/psso/ise/{uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_agents_psso_register_device_create**](docs/EndpointsApi.md#endpoints_agents_psso_register_device_create) | **POST** /endpoints/agents/psso/register/device/ |
+*EndpointsApi* | [**endpoints_agents_psso_register_user_create**](docs/EndpointsApi.md#endpoints_agents_psso_register_user_create) | **POST** /endpoints/agents/psso/register/user/ |
+*EndpointsApi* | [**endpoints_connectors_destroy**](docs/EndpointsApi.md#endpoints_connectors_destroy) | **DELETE** /endpoints/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_connectors_list**](docs/EndpointsApi.md#endpoints_connectors_list) | **GET** /endpoints/connectors/ |
+*EndpointsApi* | [**endpoints_connectors_retrieve**](docs/EndpointsApi.md#endpoints_connectors_retrieve) | **GET** /endpoints/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_connectors_types_list**](docs/EndpointsApi.md#endpoints_connectors_types_list) | **GET** /endpoints/connectors/types/ |
+*EndpointsApi* | [**endpoints_connectors_used_by_list**](docs/EndpointsApi.md#endpoints_connectors_used_by_list) | **GET** /endpoints/connectors/{connector_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_device_access_groups_create**](docs/EndpointsApi.md#endpoints_device_access_groups_create) | **POST** /endpoints/device_access_groups/ |
+*EndpointsApi* | [**endpoints_device_access_groups_destroy**](docs/EndpointsApi.md#endpoints_device_access_groups_destroy) | **DELETE** /endpoints/device_access_groups/{pbm_uuid}/ |
+*EndpointsApi* | [**endpoints_device_access_groups_list**](docs/EndpointsApi.md#endpoints_device_access_groups_list) | **GET** /endpoints/device_access_groups/ |
+*EndpointsApi* | [**endpoints_device_access_groups_partial_update**](docs/EndpointsApi.md#endpoints_device_access_groups_partial_update) | **PATCH** /endpoints/device_access_groups/{pbm_uuid}/ |
+*EndpointsApi* | [**endpoints_device_access_groups_retrieve**](docs/EndpointsApi.md#endpoints_device_access_groups_retrieve) | **GET** /endpoints/device_access_groups/{pbm_uuid}/ |
+*EndpointsApi* | [**endpoints_device_access_groups_update**](docs/EndpointsApi.md#endpoints_device_access_groups_update) | **PUT** /endpoints/device_access_groups/{pbm_uuid}/ |
+*EndpointsApi* | [**endpoints_device_access_groups_used_by_list**](docs/EndpointsApi.md#endpoints_device_access_groups_used_by_list) | **GET** /endpoints/device_access_groups/{pbm_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_device_bindings_create**](docs/EndpointsApi.md#endpoints_device_bindings_create) | **POST** /endpoints/device_bindings/ |
+*EndpointsApi* | [**endpoints_device_bindings_destroy**](docs/EndpointsApi.md#endpoints_device_bindings_destroy) | **DELETE** /endpoints/device_bindings/{policy_binding_uuid}/ |
+*EndpointsApi* | [**endpoints_device_bindings_list**](docs/EndpointsApi.md#endpoints_device_bindings_list) | **GET** /endpoints/device_bindings/ |
+*EndpointsApi* | [**endpoints_device_bindings_partial_update**](docs/EndpointsApi.md#endpoints_device_bindings_partial_update) | **PATCH** /endpoints/device_bindings/{policy_binding_uuid}/ |
+*EndpointsApi* | [**endpoints_device_bindings_retrieve**](docs/EndpointsApi.md#endpoints_device_bindings_retrieve) | **GET** /endpoints/device_bindings/{policy_binding_uuid}/ |
+*EndpointsApi* | [**endpoints_device_bindings_update**](docs/EndpointsApi.md#endpoints_device_bindings_update) | **PUT** /endpoints/device_bindings/{policy_binding_uuid}/ |
+*EndpointsApi* | [**endpoints_device_bindings_used_by_list**](docs/EndpointsApi.md#endpoints_device_bindings_used_by_list) | **GET** /endpoints/device_bindings/{policy_binding_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_devices_destroy**](docs/EndpointsApi.md#endpoints_devices_destroy) | **DELETE** /endpoints/devices/{device_uuid}/ |
+*EndpointsApi* | [**endpoints_devices_list**](docs/EndpointsApi.md#endpoints_devices_list) | **GET** /endpoints/devices/ |
+*EndpointsApi* | [**endpoints_devices_partial_update**](docs/EndpointsApi.md#endpoints_devices_partial_update) | **PATCH** /endpoints/devices/{device_uuid}/ |
+*EndpointsApi* | [**endpoints_devices_retrieve**](docs/EndpointsApi.md#endpoints_devices_retrieve) | **GET** /endpoints/devices/{device_uuid}/ |
+*EndpointsApi* | [**endpoints_devices_summary_retrieve**](docs/EndpointsApi.md#endpoints_devices_summary_retrieve) | **GET** /endpoints/devices/summary/ |
+*EndpointsApi* | [**endpoints_devices_update**](docs/EndpointsApi.md#endpoints_devices_update) | **PUT** /endpoints/devices/{device_uuid}/ |
+*EndpointsApi* | [**endpoints_devices_used_by_list**](docs/EndpointsApi.md#endpoints_devices_used_by_list) | **GET** /endpoints/devices/{device_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_create**](docs/EndpointsApi.md#endpoints_fleet_connectors_create) | **POST** /endpoints/fleet/connectors/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_destroy**](docs/EndpointsApi.md#endpoints_fleet_connectors_destroy) | **DELETE** /endpoints/fleet/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_list**](docs/EndpointsApi.md#endpoints_fleet_connectors_list) | **GET** /endpoints/fleet/connectors/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_partial_update**](docs/EndpointsApi.md#endpoints_fleet_connectors_partial_update) | **PATCH** /endpoints/fleet/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_retrieve**](docs/EndpointsApi.md#endpoints_fleet_connectors_retrieve) | **GET** /endpoints/fleet/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_update**](docs/EndpointsApi.md#endpoints_fleet_connectors_update) | **PUT** /endpoints/fleet/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_fleet_connectors_used_by_list**](docs/EndpointsApi.md#endpoints_fleet_connectors_used_by_list) | **GET** /endpoints/fleet/connectors/{connector_uuid}/used_by/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_create**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_create) | **POST** /endpoints/google_chrome/connectors/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_destroy**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_destroy) | **DELETE** /endpoints/google_chrome/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_list**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_list) | **GET** /endpoints/google_chrome/connectors/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_partial_update**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_partial_update) | **PATCH** /endpoints/google_chrome/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_retrieve**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_retrieve) | **GET** /endpoints/google_chrome/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_update**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_update) | **PUT** /endpoints/google_chrome/connectors/{connector_uuid}/ |
+*EndpointsApi* | [**endpoints_google_chrome_connectors_used_by_list**](docs/EndpointsApi.md#endpoints_google_chrome_connectors_used_by_list) | **GET** /endpoints/google_chrome/connectors/{connector_uuid}/used_by/ |
+*EnterpriseApi* | [**enterprise_license_create**](docs/EnterpriseApi.md#enterprise_license_create) | **POST** /enterprise/license/ |
+*EnterpriseApi* | [**enterprise_license_destroy**](docs/EnterpriseApi.md#enterprise_license_destroy) | **DELETE** /enterprise/license/{license_uuid}/ |
+*EnterpriseApi* | [**enterprise_license_forecast_retrieve**](docs/EnterpriseApi.md#enterprise_license_forecast_retrieve) | **GET** /enterprise/license/forecast/ |
+*EnterpriseApi* | [**enterprise_license_install_id_retrieve**](docs/EnterpriseApi.md#enterprise_license_install_id_retrieve) | **GET** /enterprise/license/install_id/ |
+*EnterpriseApi* | [**enterprise_license_list**](docs/EnterpriseApi.md#enterprise_license_list) | **GET** /enterprise/license/ |
+*EnterpriseApi* | [**enterprise_license_partial_update**](docs/EnterpriseApi.md#enterprise_license_partial_update) | **PATCH** /enterprise/license/{license_uuid}/ |
+*EnterpriseApi* | [**enterprise_license_retrieve**](docs/EnterpriseApi.md#enterprise_license_retrieve) | **GET** /enterprise/license/{license_uuid}/ |
+*EnterpriseApi* | [**enterprise_license_summary_retrieve**](docs/EnterpriseApi.md#enterprise_license_summary_retrieve) | **GET** /enterprise/license/summary/ |
+*EnterpriseApi* | [**enterprise_license_update**](docs/EnterpriseApi.md#enterprise_license_update) | **PUT** /enterprise/license/{license_uuid}/ |
+*EnterpriseApi* | [**enterprise_license_used_by_list**](docs/EnterpriseApi.md#enterprise_license_used_by_list) | **GET** /enterprise/license/{license_uuid}/used_by/ |
+*EventsApi* | [**events_events_actions_list**](docs/EventsApi.md#events_events_actions_list) | **GET** /events/events/actions/ |
+*EventsApi* | [**events_events_create**](docs/EventsApi.md#events_events_create) | **POST** /events/events/ |
+*EventsApi* | [**events_events_destroy**](docs/EventsApi.md#events_events_destroy) | **DELETE** /events/events/{event_uuid}/ |
+*EventsApi* | [**events_events_export_create**](docs/EventsApi.md#events_events_export_create) | **POST** /events/events/export/ |
+*EventsApi* | [**events_events_list**](docs/EventsApi.md#events_events_list) | **GET** /events/events/ |
+*EventsApi* | [**events_events_partial_update**](docs/EventsApi.md#events_events_partial_update) | **PATCH** /events/events/{event_uuid}/ |
+*EventsApi* | [**events_events_retrieve**](docs/EventsApi.md#events_events_retrieve) | **GET** /events/events/{event_uuid}/ |
+*EventsApi* | [**events_events_stats_retrieve**](docs/EventsApi.md#events_events_stats_retrieve) | **GET** /events/events/stats/ |
+*EventsApi* | [**events_events_top_per_user_list**](docs/EventsApi.md#events_events_top_per_user_list) | **GET** /events/events/top_per_user/ |
+*EventsApi* | [**events_events_update**](docs/EventsApi.md#events_events_update) | **PUT** /events/events/{event_uuid}/ |
+*EventsApi* | [**events_events_volume_list**](docs/EventsApi.md#events_events_volume_list) | **GET** /events/events/volume/ |
+*EventsApi* | [**events_notifications_destroy**](docs/EventsApi.md#events_notifications_destroy) | **DELETE** /events/notifications/{uuid}/ |
+*EventsApi* | [**events_notifications_list**](docs/EventsApi.md#events_notifications_list) | **GET** /events/notifications/ |
+*EventsApi* | [**events_notifications_mark_all_seen_create**](docs/EventsApi.md#events_notifications_mark_all_seen_create) | **POST** /events/notifications/mark_all_seen/ |
+*EventsApi* | [**events_notifications_partial_update**](docs/EventsApi.md#events_notifications_partial_update) | **PATCH** /events/notifications/{uuid}/ |
+*EventsApi* | [**events_notifications_retrieve**](docs/EventsApi.md#events_notifications_retrieve) | **GET** /events/notifications/{uuid}/ |
+*EventsApi* | [**events_notifications_update**](docs/EventsApi.md#events_notifications_update) | **PUT** /events/notifications/{uuid}/ |
+*EventsApi* | [**events_notifications_used_by_list**](docs/EventsApi.md#events_notifications_used_by_list) | **GET** /events/notifications/{uuid}/used_by/ |
+*EventsApi* | [**events_rules_create**](docs/EventsApi.md#events_rules_create) | **POST** /events/rules/ |
+*EventsApi* | [**events_rules_destroy**](docs/EventsApi.md#events_rules_destroy) | **DELETE** /events/rules/{pbm_uuid}/ |
+*EventsApi* | [**events_rules_list**](docs/EventsApi.md#events_rules_list) | **GET** /events/rules/ |
+*EventsApi* | [**events_rules_partial_update**](docs/EventsApi.md#events_rules_partial_update) | **PATCH** /events/rules/{pbm_uuid}/ |
+*EventsApi* | [**events_rules_retrieve**](docs/EventsApi.md#events_rules_retrieve) | **GET** /events/rules/{pbm_uuid}/ |
+*EventsApi* | [**events_rules_update**](docs/EventsApi.md#events_rules_update) | **PUT** /events/rules/{pbm_uuid}/ |
+*EventsApi* | [**events_rules_used_by_list**](docs/EventsApi.md#events_rules_used_by_list) | **GET** /events/rules/{pbm_uuid}/used_by/ |
+*EventsApi* | [**events_transports_create**](docs/EventsApi.md#events_transports_create) | **POST** /events/transports/ |
+*EventsApi* | [**events_transports_destroy**](docs/EventsApi.md#events_transports_destroy) | **DELETE** /events/transports/{uuid}/ |
+*EventsApi* | [**events_transports_list**](docs/EventsApi.md#events_transports_list) | **GET** /events/transports/ |
+*EventsApi* | [**events_transports_partial_update**](docs/EventsApi.md#events_transports_partial_update) | **PATCH** /events/transports/{uuid}/ |
+*EventsApi* | [**events_transports_retrieve**](docs/EventsApi.md#events_transports_retrieve) | **GET** /events/transports/{uuid}/ |
+*EventsApi* | [**events_transports_test_create**](docs/EventsApi.md#events_transports_test_create) | **POST** /events/transports/{uuid}/test/ |
+*EventsApi* | [**events_transports_update**](docs/EventsApi.md#events_transports_update) | **PUT** /events/transports/{uuid}/ |
+*EventsApi* | [**events_transports_used_by_list**](docs/EventsApi.md#events_transports_used_by_list) | **GET** /events/transports/{uuid}/used_by/ |
+*FlowsApi* | [**flows_bindings_create**](docs/FlowsApi.md#flows_bindings_create) | **POST** /flows/bindings/ |
+*FlowsApi* | [**flows_bindings_destroy**](docs/FlowsApi.md#flows_bindings_destroy) | **DELETE** /flows/bindings/{fsb_uuid}/ |
+*FlowsApi* | [**flows_bindings_list**](docs/FlowsApi.md#flows_bindings_list) | **GET** /flows/bindings/ |
+*FlowsApi* | [**flows_bindings_partial_update**](docs/FlowsApi.md#flows_bindings_partial_update) | **PATCH** /flows/bindings/{fsb_uuid}/ |
+*FlowsApi* | [**flows_bindings_retrieve**](docs/FlowsApi.md#flows_bindings_retrieve) | **GET** /flows/bindings/{fsb_uuid}/ |
+*FlowsApi* | [**flows_bindings_update**](docs/FlowsApi.md#flows_bindings_update) | **PUT** /flows/bindings/{fsb_uuid}/ |
+*FlowsApi* | [**flows_bindings_used_by_list**](docs/FlowsApi.md#flows_bindings_used_by_list) | **GET** /flows/bindings/{fsb_uuid}/used_by/ |
+*FlowsApi* | [**flows_executor_get**](docs/FlowsApi.md#flows_executor_get) | **GET** /flows/executor/{flow_slug}/ |
+*FlowsApi* | [**flows_executor_solve**](docs/FlowsApi.md#flows_executor_solve) | **POST** /flows/executor/{flow_slug}/ |
+*FlowsApi* | [**flows_inspector_get**](docs/FlowsApi.md#flows_inspector_get) | **GET** /flows/inspector/{flow_slug}/ |
+*FlowsApi* | [**flows_instances_cache_clear_create**](docs/FlowsApi.md#flows_instances_cache_clear_create) | **POST** /flows/instances/cache_clear/ |
+*FlowsApi* | [**flows_instances_cache_info_retrieve**](docs/FlowsApi.md#flows_instances_cache_info_retrieve) | **GET** /flows/instances/cache_info/ |
+*FlowsApi* | [**flows_instances_create**](docs/FlowsApi.md#flows_instances_create) | **POST** /flows/instances/ |
+*FlowsApi* | [**flows_instances_destroy**](docs/FlowsApi.md#flows_instances_destroy) | **DELETE** /flows/instances/{slug}/ |
+*FlowsApi* | [**flows_instances_diagram_retrieve**](docs/FlowsApi.md#flows_instances_diagram_retrieve) | **GET** /flows/instances/{slug}/diagram/ |
+*FlowsApi* | [**flows_instances_execute_retrieve**](docs/FlowsApi.md#flows_instances_execute_retrieve) | **GET** /flows/instances/{slug}/execute/ |
+*FlowsApi* | [**flows_instances_export_retrieve**](docs/FlowsApi.md#flows_instances_export_retrieve) | **GET** /flows/instances/{slug}/export/ |
+*FlowsApi* | [**flows_instances_list**](docs/FlowsApi.md#flows_instances_list) | **GET** /flows/instances/ |
+*FlowsApi* | [**flows_instances_partial_update**](docs/FlowsApi.md#flows_instances_partial_update) | **PATCH** /flows/instances/{slug}/ |
+*FlowsApi* | [**flows_instances_retrieve**](docs/FlowsApi.md#flows_instances_retrieve) | **GET** /flows/instances/{slug}/ |
+*FlowsApi* | [**flows_instances_update**](docs/FlowsApi.md#flows_instances_update) | **PUT** /flows/instances/{slug}/ |
+*FlowsApi* | [**flows_instances_used_by_list**](docs/FlowsApi.md#flows_instances_used_by_list) | **GET** /flows/instances/{slug}/used_by/ |
+*LifecycleApi* | [**lifecycle_iterations_create**](docs/LifecycleApi.md#lifecycle_iterations_create) | **POST** /lifecycle/iterations/ |
+*LifecycleApi* | [**lifecycle_iterations_list_latest**](docs/LifecycleApi.md#lifecycle_iterations_list_latest) | **GET** /lifecycle/iterations/latest/{content_type}/{object_id}/ |
+*LifecycleApi* | [**lifecycle_iterations_list_open**](docs/LifecycleApi.md#lifecycle_iterations_list_open) | **GET** /lifecycle/iterations/open/ |
+*LifecycleApi* | [**lifecycle_reviews_create**](docs/LifecycleApi.md#lifecycle_reviews_create) | **POST** /lifecycle/reviews/ |
+*LifecycleApi* | [**lifecycle_rules_create**](docs/LifecycleApi.md#lifecycle_rules_create) | **POST** /lifecycle/rules/ |
+*LifecycleApi* | [**lifecycle_rules_destroy**](docs/LifecycleApi.md#lifecycle_rules_destroy) | **DELETE** /lifecycle/rules/{id}/ |
+*LifecycleApi* | [**lifecycle_rules_list**](docs/LifecycleApi.md#lifecycle_rules_list) | **GET** /lifecycle/rules/ |
+*LifecycleApi* | [**lifecycle_rules_partial_update**](docs/LifecycleApi.md#lifecycle_rules_partial_update) | **PATCH** /lifecycle/rules/{id}/ |
+*LifecycleApi* | [**lifecycle_rules_retrieve**](docs/LifecycleApi.md#lifecycle_rules_retrieve) | **GET** /lifecycle/rules/{id}/ |
+*LifecycleApi* | [**lifecycle_rules_update**](docs/LifecycleApi.md#lifecycle_rules_update) | **PUT** /lifecycle/rules/{id}/ |
+*ManagedApi* | [**managed_blueprints_apply_create**](docs/ManagedApi.md#managed_blueprints_apply_create) | **POST** /managed/blueprints/{instance_uuid}/apply/ |
+*ManagedApi* | [**managed_blueprints_available_list**](docs/ManagedApi.md#managed_blueprints_available_list) | **GET** /managed/blueprints/available/ |
+*ManagedApi* | [**managed_blueprints_create**](docs/ManagedApi.md#managed_blueprints_create) | **POST** /managed/blueprints/ |
+*ManagedApi* | [**managed_blueprints_destroy**](docs/ManagedApi.md#managed_blueprints_destroy) | **DELETE** /managed/blueprints/{instance_uuid}/ |
+*ManagedApi* | [**managed_blueprints_import_create**](docs/ManagedApi.md#managed_blueprints_import_create) | **POST** /managed/blueprints/import/ |
+*ManagedApi* | [**managed_blueprints_list**](docs/ManagedApi.md#managed_blueprints_list) | **GET** /managed/blueprints/ |
+*ManagedApi* | [**managed_blueprints_partial_update**](docs/ManagedApi.md#managed_blueprints_partial_update) | **PATCH** /managed/blueprints/{instance_uuid}/ |
+*ManagedApi* | [**managed_blueprints_retrieve**](docs/ManagedApi.md#managed_blueprints_retrieve) | **GET** /managed/blueprints/{instance_uuid}/ |
+*ManagedApi* | [**managed_blueprints_update**](docs/ManagedApi.md#managed_blueprints_update) | **PUT** /managed/blueprints/{instance_uuid}/ |
+*ManagedApi* | [**managed_blueprints_used_by_list**](docs/ManagedApi.md#managed_blueprints_used_by_list) | **GET** /managed/blueprints/{instance_uuid}/used_by/ |
+*Oauth2Api* | [**oauth2_access_tokens_destroy**](docs/Oauth2Api.md#oauth2_access_tokens_destroy) | **DELETE** /oauth2/access_tokens/{id}/ |
+*Oauth2Api* | [**oauth2_access_tokens_list**](docs/Oauth2Api.md#oauth2_access_tokens_list) | **GET** /oauth2/access_tokens/ |
+*Oauth2Api* | [**oauth2_access_tokens_retrieve**](docs/Oauth2Api.md#oauth2_access_tokens_retrieve) | **GET** /oauth2/access_tokens/{id}/ |
+*Oauth2Api* | [**oauth2_access_tokens_used_by_list**](docs/Oauth2Api.md#oauth2_access_tokens_used_by_list) | **GET** /oauth2/access_tokens/{id}/used_by/ |
+*Oauth2Api* | [**oauth2_authorization_codes_destroy**](docs/Oauth2Api.md#oauth2_authorization_codes_destroy) | **DELETE** /oauth2/authorization_codes/{id}/ |
+*Oauth2Api* | [**oauth2_authorization_codes_list**](docs/Oauth2Api.md#oauth2_authorization_codes_list) | **GET** /oauth2/authorization_codes/ |
+*Oauth2Api* | [**oauth2_authorization_codes_retrieve**](docs/Oauth2Api.md#oauth2_authorization_codes_retrieve) | **GET** /oauth2/authorization_codes/{id}/ |
+*Oauth2Api* | [**oauth2_authorization_codes_used_by_list**](docs/Oauth2Api.md#oauth2_authorization_codes_used_by_list) | **GET** /oauth2/authorization_codes/{id}/used_by/ |
+*Oauth2Api* | [**oauth2_refresh_tokens_destroy**](docs/Oauth2Api.md#oauth2_refresh_tokens_destroy) | **DELETE** /oauth2/refresh_tokens/{id}/ |
+*Oauth2Api* | [**oauth2_refresh_tokens_list**](docs/Oauth2Api.md#oauth2_refresh_tokens_list) | **GET** /oauth2/refresh_tokens/ |
+*Oauth2Api* | [**oauth2_refresh_tokens_retrieve**](docs/Oauth2Api.md#oauth2_refresh_tokens_retrieve) | **GET** /oauth2/refresh_tokens/{id}/ |
+*Oauth2Api* | [**oauth2_refresh_tokens_used_by_list**](docs/Oauth2Api.md#oauth2_refresh_tokens_used_by_list) | **GET** /oauth2/refresh_tokens/{id}/used_by/ |
+*OutpostsApi* | [**outposts_instances_create**](docs/OutpostsApi.md#outposts_instances_create) | **POST** /outposts/instances/ |
+*OutpostsApi* | [**outposts_instances_default_settings_retrieve**](docs/OutpostsApi.md#outposts_instances_default_settings_retrieve) | **GET** /outposts/instances/default_settings/ |
+*OutpostsApi* | [**outposts_instances_destroy**](docs/OutpostsApi.md#outposts_instances_destroy) | **DELETE** /outposts/instances/{uuid}/ |
+*OutpostsApi* | [**outposts_instances_health_list**](docs/OutpostsApi.md#outposts_instances_health_list) | **GET** /outposts/instances/{uuid}/health/ |
+*OutpostsApi* | [**outposts_instances_list**](docs/OutpostsApi.md#outposts_instances_list) | **GET** /outposts/instances/ |
+*OutpostsApi* | [**outposts_instances_partial_update**](docs/OutpostsApi.md#outposts_instances_partial_update) | **PATCH** /outposts/instances/{uuid}/ |
+*OutpostsApi* | [**outposts_instances_retrieve**](docs/OutpostsApi.md#outposts_instances_retrieve) | **GET** /outposts/instances/{uuid}/ |
+*OutpostsApi* | [**outposts_instances_update**](docs/OutpostsApi.md#outposts_instances_update) | **PUT** /outposts/instances/{uuid}/ |
+*OutpostsApi* | [**outposts_instances_used_by_list**](docs/OutpostsApi.md#outposts_instances_used_by_list) | **GET** /outposts/instances/{uuid}/used_by/ |
+*OutpostsApi* | [**outposts_ldap_access_check**](docs/OutpostsApi.md#outposts_ldap_access_check) | **GET** /outposts/ldap/{id}/check_access/ |
+*OutpostsApi* | [**outposts_ldap_list**](docs/OutpostsApi.md#outposts_ldap_list) | **GET** /outposts/ldap/ |
+*OutpostsApi* | [**outposts_proxy_list**](docs/OutpostsApi.md#outposts_proxy_list) | **GET** /outposts/proxy/ |
+*OutpostsApi* | [**outposts_radius_access_check**](docs/OutpostsApi.md#outposts_radius_access_check) | **GET** /outposts/radius/{id}/check_access/ |
+*OutpostsApi* | [**outposts_radius_list**](docs/OutpostsApi.md#outposts_radius_list) | **GET** /outposts/radius/ |
+*OutpostsApi* | [**outposts_service_connections_all_destroy**](docs/OutpostsApi.md#outposts_service_connections_all_destroy) | **DELETE** /outposts/service_connections/all/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_all_list**](docs/OutpostsApi.md#outposts_service_connections_all_list) | **GET** /outposts/service_connections/all/ |
+*OutpostsApi* | [**outposts_service_connections_all_retrieve**](docs/OutpostsApi.md#outposts_service_connections_all_retrieve) | **GET** /outposts/service_connections/all/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_all_state_retrieve**](docs/OutpostsApi.md#outposts_service_connections_all_state_retrieve) | **GET** /outposts/service_connections/all/{uuid}/state/ |
+*OutpostsApi* | [**outposts_service_connections_all_types_list**](docs/OutpostsApi.md#outposts_service_connections_all_types_list) | **GET** /outposts/service_connections/all/types/ |
+*OutpostsApi* | [**outposts_service_connections_all_used_by_list**](docs/OutpostsApi.md#outposts_service_connections_all_used_by_list) | **GET** /outposts/service_connections/all/{uuid}/used_by/ |
+*OutpostsApi* | [**outposts_service_connections_docker_create**](docs/OutpostsApi.md#outposts_service_connections_docker_create) | **POST** /outposts/service_connections/docker/ |
+*OutpostsApi* | [**outposts_service_connections_docker_destroy**](docs/OutpostsApi.md#outposts_service_connections_docker_destroy) | **DELETE** /outposts/service_connections/docker/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_docker_list**](docs/OutpostsApi.md#outposts_service_connections_docker_list) | **GET** /outposts/service_connections/docker/ |
+*OutpostsApi* | [**outposts_service_connections_docker_partial_update**](docs/OutpostsApi.md#outposts_service_connections_docker_partial_update) | **PATCH** /outposts/service_connections/docker/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_docker_retrieve**](docs/OutpostsApi.md#outposts_service_connections_docker_retrieve) | **GET** /outposts/service_connections/docker/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_docker_update**](docs/OutpostsApi.md#outposts_service_connections_docker_update) | **PUT** /outposts/service_connections/docker/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_docker_used_by_list**](docs/OutpostsApi.md#outposts_service_connections_docker_used_by_list) | **GET** /outposts/service_connections/docker/{uuid}/used_by/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_create**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_create) | **POST** /outposts/service_connections/kubernetes/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_destroy**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_destroy) | **DELETE** /outposts/service_connections/kubernetes/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_list**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_list) | **GET** /outposts/service_connections/kubernetes/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_partial_update**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_partial_update) | **PATCH** /outposts/service_connections/kubernetes/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_retrieve**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_retrieve) | **GET** /outposts/service_connections/kubernetes/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_update**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_update) | **PUT** /outposts/service_connections/kubernetes/{uuid}/ |
+*OutpostsApi* | [**outposts_service_connections_kubernetes_used_by_list**](docs/OutpostsApi.md#outposts_service_connections_kubernetes_used_by_list) | **GET** /outposts/service_connections/kubernetes/{uuid}/used_by/ |
+*PoliciesApi* | [**policies_all_cache_clear_create**](docs/PoliciesApi.md#policies_all_cache_clear_create) | **POST** /policies/all/cache_clear/ |
+*PoliciesApi* | [**policies_all_cache_info_retrieve**](docs/PoliciesApi.md#policies_all_cache_info_retrieve) | **GET** /policies/all/cache_info/ |
+*PoliciesApi* | [**policies_all_destroy**](docs/PoliciesApi.md#policies_all_destroy) | **DELETE** /policies/all/{policy_uuid}/ |
+*PoliciesApi* | [**policies_all_list**](docs/PoliciesApi.md#policies_all_list) | **GET** /policies/all/ |
+*PoliciesApi* | [**policies_all_retrieve**](docs/PoliciesApi.md#policies_all_retrieve) | **GET** /policies/all/{policy_uuid}/ |
+*PoliciesApi* | [**policies_all_test_create**](docs/PoliciesApi.md#policies_all_test_create) | **POST** /policies/all/{policy_uuid}/test/ |
+*PoliciesApi* | [**policies_all_types_list**](docs/PoliciesApi.md#policies_all_types_list) | **GET** /policies/all/types/ |
+*PoliciesApi* | [**policies_all_used_by_list**](docs/PoliciesApi.md#policies_all_used_by_list) | **GET** /policies/all/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_bindings_create**](docs/PoliciesApi.md#policies_bindings_create) | **POST** /policies/bindings/ |
+*PoliciesApi* | [**policies_bindings_destroy**](docs/PoliciesApi.md#policies_bindings_destroy) | **DELETE** /policies/bindings/{policy_binding_uuid}/ |
+*PoliciesApi* | [**policies_bindings_list**](docs/PoliciesApi.md#policies_bindings_list) | **GET** /policies/bindings/ |
+*PoliciesApi* | [**policies_bindings_partial_update**](docs/PoliciesApi.md#policies_bindings_partial_update) | **PATCH** /policies/bindings/{policy_binding_uuid}/ |
+*PoliciesApi* | [**policies_bindings_retrieve**](docs/PoliciesApi.md#policies_bindings_retrieve) | **GET** /policies/bindings/{policy_binding_uuid}/ |
+*PoliciesApi* | [**policies_bindings_update**](docs/PoliciesApi.md#policies_bindings_update) | **PUT** /policies/bindings/{policy_binding_uuid}/ |
+*PoliciesApi* | [**policies_bindings_used_by_list**](docs/PoliciesApi.md#policies_bindings_used_by_list) | **GET** /policies/bindings/{policy_binding_uuid}/used_by/ |
+*PoliciesApi* | [**policies_dummy_create**](docs/PoliciesApi.md#policies_dummy_create) | **POST** /policies/dummy/ |
+*PoliciesApi* | [**policies_dummy_destroy**](docs/PoliciesApi.md#policies_dummy_destroy) | **DELETE** /policies/dummy/{policy_uuid}/ |
+*PoliciesApi* | [**policies_dummy_list**](docs/PoliciesApi.md#policies_dummy_list) | **GET** /policies/dummy/ |
+*PoliciesApi* | [**policies_dummy_partial_update**](docs/PoliciesApi.md#policies_dummy_partial_update) | **PATCH** /policies/dummy/{policy_uuid}/ |
+*PoliciesApi* | [**policies_dummy_retrieve**](docs/PoliciesApi.md#policies_dummy_retrieve) | **GET** /policies/dummy/{policy_uuid}/ |
+*PoliciesApi* | [**policies_dummy_update**](docs/PoliciesApi.md#policies_dummy_update) | **PUT** /policies/dummy/{policy_uuid}/ |
+*PoliciesApi* | [**policies_dummy_used_by_list**](docs/PoliciesApi.md#policies_dummy_used_by_list) | **GET** /policies/dummy/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_event_matcher_create**](docs/PoliciesApi.md#policies_event_matcher_create) | **POST** /policies/event_matcher/ |
+*PoliciesApi* | [**policies_event_matcher_destroy**](docs/PoliciesApi.md#policies_event_matcher_destroy) | **DELETE** /policies/event_matcher/{policy_uuid}/ |
+*PoliciesApi* | [**policies_event_matcher_list**](docs/PoliciesApi.md#policies_event_matcher_list) | **GET** /policies/event_matcher/ |
+*PoliciesApi* | [**policies_event_matcher_partial_update**](docs/PoliciesApi.md#policies_event_matcher_partial_update) | **PATCH** /policies/event_matcher/{policy_uuid}/ |
+*PoliciesApi* | [**policies_event_matcher_retrieve**](docs/PoliciesApi.md#policies_event_matcher_retrieve) | **GET** /policies/event_matcher/{policy_uuid}/ |
+*PoliciesApi* | [**policies_event_matcher_update**](docs/PoliciesApi.md#policies_event_matcher_update) | **PUT** /policies/event_matcher/{policy_uuid}/ |
+*PoliciesApi* | [**policies_event_matcher_used_by_list**](docs/PoliciesApi.md#policies_event_matcher_used_by_list) | **GET** /policies/event_matcher/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_expression_create**](docs/PoliciesApi.md#policies_expression_create) | **POST** /policies/expression/ |
+*PoliciesApi* | [**policies_expression_destroy**](docs/PoliciesApi.md#policies_expression_destroy) | **DELETE** /policies/expression/{policy_uuid}/ |
+*PoliciesApi* | [**policies_expression_list**](docs/PoliciesApi.md#policies_expression_list) | **GET** /policies/expression/ |
+*PoliciesApi* | [**policies_expression_partial_update**](docs/PoliciesApi.md#policies_expression_partial_update) | **PATCH** /policies/expression/{policy_uuid}/ |
+*PoliciesApi* | [**policies_expression_retrieve**](docs/PoliciesApi.md#policies_expression_retrieve) | **GET** /policies/expression/{policy_uuid}/ |
+*PoliciesApi* | [**policies_expression_update**](docs/PoliciesApi.md#policies_expression_update) | **PUT** /policies/expression/{policy_uuid}/ |
+*PoliciesApi* | [**policies_expression_used_by_list**](docs/PoliciesApi.md#policies_expression_used_by_list) | **GET** /policies/expression/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_geoip_create**](docs/PoliciesApi.md#policies_geoip_create) | **POST** /policies/geoip/ |
+*PoliciesApi* | [**policies_geoip_destroy**](docs/PoliciesApi.md#policies_geoip_destroy) | **DELETE** /policies/geoip/{policy_uuid}/ |
+*PoliciesApi* | [**policies_geoip_iso3166_list**](docs/PoliciesApi.md#policies_geoip_iso3166_list) | **GET** /policies/geoip_iso3166/ |
+*PoliciesApi* | [**policies_geoip_list**](docs/PoliciesApi.md#policies_geoip_list) | **GET** /policies/geoip/ |
+*PoliciesApi* | [**policies_geoip_partial_update**](docs/PoliciesApi.md#policies_geoip_partial_update) | **PATCH** /policies/geoip/{policy_uuid}/ |
+*PoliciesApi* | [**policies_geoip_retrieve**](docs/PoliciesApi.md#policies_geoip_retrieve) | **GET** /policies/geoip/{policy_uuid}/ |
+*PoliciesApi* | [**policies_geoip_update**](docs/PoliciesApi.md#policies_geoip_update) | **PUT** /policies/geoip/{policy_uuid}/ |
+*PoliciesApi* | [**policies_geoip_used_by_list**](docs/PoliciesApi.md#policies_geoip_used_by_list) | **GET** /policies/geoip/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_password_create**](docs/PoliciesApi.md#policies_password_create) | **POST** /policies/password/ |
+*PoliciesApi* | [**policies_password_destroy**](docs/PoliciesApi.md#policies_password_destroy) | **DELETE** /policies/password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_expiry_create**](docs/PoliciesApi.md#policies_password_expiry_create) | **POST** /policies/password_expiry/ |
+*PoliciesApi* | [**policies_password_expiry_destroy**](docs/PoliciesApi.md#policies_password_expiry_destroy) | **DELETE** /policies/password_expiry/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_expiry_list**](docs/PoliciesApi.md#policies_password_expiry_list) | **GET** /policies/password_expiry/ |
+*PoliciesApi* | [**policies_password_expiry_partial_update**](docs/PoliciesApi.md#policies_password_expiry_partial_update) | **PATCH** /policies/password_expiry/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_expiry_retrieve**](docs/PoliciesApi.md#policies_password_expiry_retrieve) | **GET** /policies/password_expiry/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_expiry_update**](docs/PoliciesApi.md#policies_password_expiry_update) | **PUT** /policies/password_expiry/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_expiry_used_by_list**](docs/PoliciesApi.md#policies_password_expiry_used_by_list) | **GET** /policies/password_expiry/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_password_list**](docs/PoliciesApi.md#policies_password_list) | **GET** /policies/password/ |
+*PoliciesApi* | [**policies_password_partial_update**](docs/PoliciesApi.md#policies_password_partial_update) | **PATCH** /policies/password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_retrieve**](docs/PoliciesApi.md#policies_password_retrieve) | **GET** /policies/password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_update**](docs/PoliciesApi.md#policies_password_update) | **PUT** /policies/password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_password_used_by_list**](docs/PoliciesApi.md#policies_password_used_by_list) | **GET** /policies/password/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_reputation_create**](docs/PoliciesApi.md#policies_reputation_create) | **POST** /policies/reputation/ |
+*PoliciesApi* | [**policies_reputation_destroy**](docs/PoliciesApi.md#policies_reputation_destroy) | **DELETE** /policies/reputation/{policy_uuid}/ |
+*PoliciesApi* | [**policies_reputation_list**](docs/PoliciesApi.md#policies_reputation_list) | **GET** /policies/reputation/ |
+*PoliciesApi* | [**policies_reputation_partial_update**](docs/PoliciesApi.md#policies_reputation_partial_update) | **PATCH** /policies/reputation/{policy_uuid}/ |
+*PoliciesApi* | [**policies_reputation_retrieve**](docs/PoliciesApi.md#policies_reputation_retrieve) | **GET** /policies/reputation/{policy_uuid}/ |
+*PoliciesApi* | [**policies_reputation_scores_destroy**](docs/PoliciesApi.md#policies_reputation_scores_destroy) | **DELETE** /policies/reputation/scores/{reputation_uuid}/ |
+*PoliciesApi* | [**policies_reputation_scores_list**](docs/PoliciesApi.md#policies_reputation_scores_list) | **GET** /policies/reputation/scores/ |
+*PoliciesApi* | [**policies_reputation_scores_retrieve**](docs/PoliciesApi.md#policies_reputation_scores_retrieve) | **GET** /policies/reputation/scores/{reputation_uuid}/ |
+*PoliciesApi* | [**policies_reputation_scores_used_by_list**](docs/PoliciesApi.md#policies_reputation_scores_used_by_list) | **GET** /policies/reputation/scores/{reputation_uuid}/used_by/ |
+*PoliciesApi* | [**policies_reputation_update**](docs/PoliciesApi.md#policies_reputation_update) | **PUT** /policies/reputation/{policy_uuid}/ |
+*PoliciesApi* | [**policies_reputation_used_by_list**](docs/PoliciesApi.md#policies_reputation_used_by_list) | **GET** /policies/reputation/{policy_uuid}/used_by/ |
+*PoliciesApi* | [**policies_unique_password_create**](docs/PoliciesApi.md#policies_unique_password_create) | **POST** /policies/unique_password/ |
+*PoliciesApi* | [**policies_unique_password_destroy**](docs/PoliciesApi.md#policies_unique_password_destroy) | **DELETE** /policies/unique_password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_unique_password_list**](docs/PoliciesApi.md#policies_unique_password_list) | **GET** /policies/unique_password/ |
+*PoliciesApi* | [**policies_unique_password_partial_update**](docs/PoliciesApi.md#policies_unique_password_partial_update) | **PATCH** /policies/unique_password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_unique_password_retrieve**](docs/PoliciesApi.md#policies_unique_password_retrieve) | **GET** /policies/unique_password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_unique_password_update**](docs/PoliciesApi.md#policies_unique_password_update) | **PUT** /policies/unique_password/{policy_uuid}/ |
+*PoliciesApi* | [**policies_unique_password_used_by_list**](docs/PoliciesApi.md#policies_unique_password_used_by_list) | **GET** /policies/unique_password/{policy_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_all_destroy**](docs/PropertymappingsApi.md#propertymappings_all_destroy) | **DELETE** /propertymappings/all/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_all_list**](docs/PropertymappingsApi.md#propertymappings_all_list) | **GET** /propertymappings/all/ |
+*PropertymappingsApi* | [**propertymappings_all_retrieve**](docs/PropertymappingsApi.md#propertymappings_all_retrieve) | **GET** /propertymappings/all/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_all_test_create**](docs/PropertymappingsApi.md#propertymappings_all_test_create) | **POST** /propertymappings/all/{pm_uuid}/test/ |
+*PropertymappingsApi* | [**propertymappings_all_types_list**](docs/PropertymappingsApi.md#propertymappings_all_types_list) | **GET** /propertymappings/all/types/ |
+*PropertymappingsApi* | [**propertymappings_all_used_by_list**](docs/PropertymappingsApi.md#propertymappings_all_used_by_list) | **GET** /propertymappings/all/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_notification_create**](docs/PropertymappingsApi.md#propertymappings_notification_create) | **POST** /propertymappings/notification/ |
+*PropertymappingsApi* | [**propertymappings_notification_destroy**](docs/PropertymappingsApi.md#propertymappings_notification_destroy) | **DELETE** /propertymappings/notification/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_notification_list**](docs/PropertymappingsApi.md#propertymappings_notification_list) | **GET** /propertymappings/notification/ |
+*PropertymappingsApi* | [**propertymappings_notification_partial_update**](docs/PropertymappingsApi.md#propertymappings_notification_partial_update) | **PATCH** /propertymappings/notification/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_notification_retrieve**](docs/PropertymappingsApi.md#propertymappings_notification_retrieve) | **GET** /propertymappings/notification/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_notification_update**](docs/PropertymappingsApi.md#propertymappings_notification_update) | **PUT** /propertymappings/notification/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_notification_used_by_list**](docs/PropertymappingsApi.md#propertymappings_notification_used_by_list) | **GET** /propertymappings/notification/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_create**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_create) | **POST** /propertymappings/provider/google_workspace/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_destroy) | **DELETE** /propertymappings/provider/google_workspace/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_list**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_list) | **GET** /propertymappings/provider/google_workspace/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_partial_update) | **PATCH** /propertymappings/provider/google_workspace/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_retrieve) | **GET** /propertymappings/provider/google_workspace/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_update**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_update) | **PUT** /propertymappings/provider/google_workspace/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_google_workspace_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_google_workspace_used_by_list) | **GET** /propertymappings/provider/google_workspace/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_create**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_create) | **POST** /propertymappings/provider/microsoft_entra/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_destroy) | **DELETE** /propertymappings/provider/microsoft_entra/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_list**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_list) | **GET** /propertymappings/provider/microsoft_entra/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_partial_update) | **PATCH** /propertymappings/provider/microsoft_entra/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_retrieve) | **GET** /propertymappings/provider/microsoft_entra/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_update**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_update) | **PUT** /propertymappings/provider/microsoft_entra/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_microsoft_entra_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_microsoft_entra_used_by_list) | **GET** /propertymappings/provider/microsoft_entra/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_create**](docs/PropertymappingsApi.md#propertymappings_provider_rac_create) | **POST** /propertymappings/provider/rac/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_rac_destroy) | **DELETE** /propertymappings/provider/rac/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_list**](docs/PropertymappingsApi.md#propertymappings_provider_rac_list) | **GET** /propertymappings/provider/rac/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_rac_partial_update) | **PATCH** /propertymappings/provider/rac/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_rac_retrieve) | **GET** /propertymappings/provider/rac/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_update**](docs/PropertymappingsApi.md#propertymappings_provider_rac_update) | **PUT** /propertymappings/provider/rac/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_rac_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_rac_used_by_list) | **GET** /propertymappings/provider/rac/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_create**](docs/PropertymappingsApi.md#propertymappings_provider_radius_create) | **POST** /propertymappings/provider/radius/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_radius_destroy) | **DELETE** /propertymappings/provider/radius/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_list**](docs/PropertymappingsApi.md#propertymappings_provider_radius_list) | **GET** /propertymappings/provider/radius/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_radius_partial_update) | **PATCH** /propertymappings/provider/radius/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_radius_retrieve) | **GET** /propertymappings/provider/radius/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_update**](docs/PropertymappingsApi.md#propertymappings_provider_radius_update) | **PUT** /propertymappings/provider/radius/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_radius_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_radius_used_by_list) | **GET** /propertymappings/provider/radius/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_create**](docs/PropertymappingsApi.md#propertymappings_provider_saml_create) | **POST** /propertymappings/provider/saml/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_saml_destroy) | **DELETE** /propertymappings/provider/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_list**](docs/PropertymappingsApi.md#propertymappings_provider_saml_list) | **GET** /propertymappings/provider/saml/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_saml_partial_update) | **PATCH** /propertymappings/provider/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_saml_retrieve) | **GET** /propertymappings/provider/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_update**](docs/PropertymappingsApi.md#propertymappings_provider_saml_update) | **PUT** /propertymappings/provider/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_saml_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_saml_used_by_list) | **GET** /propertymappings/provider/saml/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_create**](docs/PropertymappingsApi.md#propertymappings_provider_scim_create) | **POST** /propertymappings/provider/scim/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_scim_destroy) | **DELETE** /propertymappings/provider/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_list**](docs/PropertymappingsApi.md#propertymappings_provider_scim_list) | **GET** /propertymappings/provider/scim/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_scim_partial_update) | **PATCH** /propertymappings/provider/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_scim_retrieve) | **GET** /propertymappings/provider/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_update**](docs/PropertymappingsApi.md#propertymappings_provider_scim_update) | **PUT** /propertymappings/provider/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scim_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_scim_used_by_list) | **GET** /propertymappings/provider/scim/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_create**](docs/PropertymappingsApi.md#propertymappings_provider_scope_create) | **POST** /propertymappings/provider/scope/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_destroy**](docs/PropertymappingsApi.md#propertymappings_provider_scope_destroy) | **DELETE** /propertymappings/provider/scope/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_list**](docs/PropertymappingsApi.md#propertymappings_provider_scope_list) | **GET** /propertymappings/provider/scope/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_partial_update**](docs/PropertymappingsApi.md#propertymappings_provider_scope_partial_update) | **PATCH** /propertymappings/provider/scope/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_retrieve**](docs/PropertymappingsApi.md#propertymappings_provider_scope_retrieve) | **GET** /propertymappings/provider/scope/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_update**](docs/PropertymappingsApi.md#propertymappings_provider_scope_update) | **PUT** /propertymappings/provider/scope/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_provider_scope_used_by_list**](docs/PropertymappingsApi.md#propertymappings_provider_scope_used_by_list) | **GET** /propertymappings/provider/scope/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_create**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_create) | **POST** /propertymappings/source/kerberos/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_destroy**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_destroy) | **DELETE** /propertymappings/source/kerberos/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_list**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_list) | **GET** /propertymappings/source/kerberos/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_partial_update) | **PATCH** /propertymappings/source/kerberos/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_retrieve) | **GET** /propertymappings/source/kerberos/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_update**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_update) | **PUT** /propertymappings/source/kerberos/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_kerberos_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_kerberos_used_by_list) | **GET** /propertymappings/source/kerberos/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_create**](docs/PropertymappingsApi.md#propertymappings_source_ldap_create) | **POST** /propertymappings/source/ldap/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_destroy**](docs/PropertymappingsApi.md#propertymappings_source_ldap_destroy) | **DELETE** /propertymappings/source/ldap/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_list**](docs/PropertymappingsApi.md#propertymappings_source_ldap_list) | **GET** /propertymappings/source/ldap/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_ldap_partial_update) | **PATCH** /propertymappings/source/ldap/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_ldap_retrieve) | **GET** /propertymappings/source/ldap/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_update**](docs/PropertymappingsApi.md#propertymappings_source_ldap_update) | **PUT** /propertymappings/source/ldap/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_ldap_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_ldap_used_by_list) | **GET** /propertymappings/source/ldap/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_create**](docs/PropertymappingsApi.md#propertymappings_source_oauth_create) | **POST** /propertymappings/source/oauth/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_destroy**](docs/PropertymappingsApi.md#propertymappings_source_oauth_destroy) | **DELETE** /propertymappings/source/oauth/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_list**](docs/PropertymappingsApi.md#propertymappings_source_oauth_list) | **GET** /propertymappings/source/oauth/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_oauth_partial_update) | **PATCH** /propertymappings/source/oauth/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_oauth_retrieve) | **GET** /propertymappings/source/oauth/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_update**](docs/PropertymappingsApi.md#propertymappings_source_oauth_update) | **PUT** /propertymappings/source/oauth/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_oauth_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_oauth_used_by_list) | **GET** /propertymappings/source/oauth/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_create**](docs/PropertymappingsApi.md#propertymappings_source_plex_create) | **POST** /propertymappings/source/plex/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_destroy**](docs/PropertymappingsApi.md#propertymappings_source_plex_destroy) | **DELETE** /propertymappings/source/plex/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_list**](docs/PropertymappingsApi.md#propertymappings_source_plex_list) | **GET** /propertymappings/source/plex/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_plex_partial_update) | **PATCH** /propertymappings/source/plex/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_plex_retrieve) | **GET** /propertymappings/source/plex/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_update**](docs/PropertymappingsApi.md#propertymappings_source_plex_update) | **PUT** /propertymappings/source/plex/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_plex_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_plex_used_by_list) | **GET** /propertymappings/source/plex/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_create**](docs/PropertymappingsApi.md#propertymappings_source_saml_create) | **POST** /propertymappings/source/saml/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_destroy**](docs/PropertymappingsApi.md#propertymappings_source_saml_destroy) | **DELETE** /propertymappings/source/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_list**](docs/PropertymappingsApi.md#propertymappings_source_saml_list) | **GET** /propertymappings/source/saml/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_saml_partial_update) | **PATCH** /propertymappings/source/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_saml_retrieve) | **GET** /propertymappings/source/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_update**](docs/PropertymappingsApi.md#propertymappings_source_saml_update) | **PUT** /propertymappings/source/saml/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_saml_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_saml_used_by_list) | **GET** /propertymappings/source/saml/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_create**](docs/PropertymappingsApi.md#propertymappings_source_scim_create) | **POST** /propertymappings/source/scim/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_destroy**](docs/PropertymappingsApi.md#propertymappings_source_scim_destroy) | **DELETE** /propertymappings/source/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_list**](docs/PropertymappingsApi.md#propertymappings_source_scim_list) | **GET** /propertymappings/source/scim/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_scim_partial_update) | **PATCH** /propertymappings/source/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_scim_retrieve) | **GET** /propertymappings/source/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_update**](docs/PropertymappingsApi.md#propertymappings_source_scim_update) | **PUT** /propertymappings/source/scim/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_scim_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_scim_used_by_list) | **GET** /propertymappings/source/scim/{pm_uuid}/used_by/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_create**](docs/PropertymappingsApi.md#propertymappings_source_telegram_create) | **POST** /propertymappings/source/telegram/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_destroy**](docs/PropertymappingsApi.md#propertymappings_source_telegram_destroy) | **DELETE** /propertymappings/source/telegram/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_list**](docs/PropertymappingsApi.md#propertymappings_source_telegram_list) | **GET** /propertymappings/source/telegram/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_partial_update**](docs/PropertymappingsApi.md#propertymappings_source_telegram_partial_update) | **PATCH** /propertymappings/source/telegram/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_retrieve**](docs/PropertymappingsApi.md#propertymappings_source_telegram_retrieve) | **GET** /propertymappings/source/telegram/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_update**](docs/PropertymappingsApi.md#propertymappings_source_telegram_update) | **PUT** /propertymappings/source/telegram/{pm_uuid}/ |
+*PropertymappingsApi* | [**propertymappings_source_telegram_used_by_list**](docs/PropertymappingsApi.md#propertymappings_source_telegram_used_by_list) | **GET** /propertymappings/source/telegram/{pm_uuid}/used_by/ |
+*ProvidersApi* | [**providers_all_destroy**](docs/ProvidersApi.md#providers_all_destroy) | **DELETE** /providers/all/{id}/ |
+*ProvidersApi* | [**providers_all_list**](docs/ProvidersApi.md#providers_all_list) | **GET** /providers/all/ |
+*ProvidersApi* | [**providers_all_retrieve**](docs/ProvidersApi.md#providers_all_retrieve) | **GET** /providers/all/{id}/ |
+*ProvidersApi* | [**providers_all_types_list**](docs/ProvidersApi.md#providers_all_types_list) | **GET** /providers/all/types/ |
+*ProvidersApi* | [**providers_all_used_by_list**](docs/ProvidersApi.md#providers_all_used_by_list) | **GET** /providers/all/{id}/used_by/ |
+*ProvidersApi* | [**providers_google_workspace_create**](docs/ProvidersApi.md#providers_google_workspace_create) | **POST** /providers/google_workspace/ |
+*ProvidersApi* | [**providers_google_workspace_destroy**](docs/ProvidersApi.md#providers_google_workspace_destroy) | **DELETE** /providers/google_workspace/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_groups_create**](docs/ProvidersApi.md#providers_google_workspace_groups_create) | **POST** /providers/google_workspace_groups/ |
+*ProvidersApi* | [**providers_google_workspace_groups_destroy**](docs/ProvidersApi.md#providers_google_workspace_groups_destroy) | **DELETE** /providers/google_workspace_groups/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_groups_list**](docs/ProvidersApi.md#providers_google_workspace_groups_list) | **GET** /providers/google_workspace_groups/ |
+*ProvidersApi* | [**providers_google_workspace_groups_retrieve**](docs/ProvidersApi.md#providers_google_workspace_groups_retrieve) | **GET** /providers/google_workspace_groups/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_groups_used_by_list**](docs/ProvidersApi.md#providers_google_workspace_groups_used_by_list) | **GET** /providers/google_workspace_groups/{id}/used_by/ |
+*ProvidersApi* | [**providers_google_workspace_list**](docs/ProvidersApi.md#providers_google_workspace_list) | **GET** /providers/google_workspace/ |
+*ProvidersApi* | [**providers_google_workspace_partial_update**](docs/ProvidersApi.md#providers_google_workspace_partial_update) | **PATCH** /providers/google_workspace/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_retrieve**](docs/ProvidersApi.md#providers_google_workspace_retrieve) | **GET** /providers/google_workspace/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_sync_object_create**](docs/ProvidersApi.md#providers_google_workspace_sync_object_create) | **POST** /providers/google_workspace/{id}/sync/object/ |
+*ProvidersApi* | [**providers_google_workspace_sync_status_retrieve**](docs/ProvidersApi.md#providers_google_workspace_sync_status_retrieve) | **GET** /providers/google_workspace/{id}/sync/status/ |
+*ProvidersApi* | [**providers_google_workspace_update**](docs/ProvidersApi.md#providers_google_workspace_update) | **PUT** /providers/google_workspace/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_used_by_list**](docs/ProvidersApi.md#providers_google_workspace_used_by_list) | **GET** /providers/google_workspace/{id}/used_by/ |
+*ProvidersApi* | [**providers_google_workspace_users_create**](docs/ProvidersApi.md#providers_google_workspace_users_create) | **POST** /providers/google_workspace_users/ |
+*ProvidersApi* | [**providers_google_workspace_users_destroy**](docs/ProvidersApi.md#providers_google_workspace_users_destroy) | **DELETE** /providers/google_workspace_users/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_users_list**](docs/ProvidersApi.md#providers_google_workspace_users_list) | **GET** /providers/google_workspace_users/ |
+*ProvidersApi* | [**providers_google_workspace_users_retrieve**](docs/ProvidersApi.md#providers_google_workspace_users_retrieve) | **GET** /providers/google_workspace_users/{id}/ |
+*ProvidersApi* | [**providers_google_workspace_users_used_by_list**](docs/ProvidersApi.md#providers_google_workspace_users_used_by_list) | **GET** /providers/google_workspace_users/{id}/used_by/ |
+*ProvidersApi* | [**providers_ldap_create**](docs/ProvidersApi.md#providers_ldap_create) | **POST** /providers/ldap/ |
+*ProvidersApi* | [**providers_ldap_destroy**](docs/ProvidersApi.md#providers_ldap_destroy) | **DELETE** /providers/ldap/{id}/ |
+*ProvidersApi* | [**providers_ldap_list**](docs/ProvidersApi.md#providers_ldap_list) | **GET** /providers/ldap/ |
+*ProvidersApi* | [**providers_ldap_partial_update**](docs/ProvidersApi.md#providers_ldap_partial_update) | **PATCH** /providers/ldap/{id}/ |
+*ProvidersApi* | [**providers_ldap_retrieve**](docs/ProvidersApi.md#providers_ldap_retrieve) | **GET** /providers/ldap/{id}/ |
+*ProvidersApi* | [**providers_ldap_update**](docs/ProvidersApi.md#providers_ldap_update) | **PUT** /providers/ldap/{id}/ |
+*ProvidersApi* | [**providers_ldap_used_by_list**](docs/ProvidersApi.md#providers_ldap_used_by_list) | **GET** /providers/ldap/{id}/used_by/ |
+*ProvidersApi* | [**providers_microsoft_entra_create**](docs/ProvidersApi.md#providers_microsoft_entra_create) | **POST** /providers/microsoft_entra/ |
+*ProvidersApi* | [**providers_microsoft_entra_destroy**](docs/ProvidersApi.md#providers_microsoft_entra_destroy) | **DELETE** /providers/microsoft_entra/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_groups_create**](docs/ProvidersApi.md#providers_microsoft_entra_groups_create) | **POST** /providers/microsoft_entra_groups/ |
+*ProvidersApi* | [**providers_microsoft_entra_groups_destroy**](docs/ProvidersApi.md#providers_microsoft_entra_groups_destroy) | **DELETE** /providers/microsoft_entra_groups/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_groups_list**](docs/ProvidersApi.md#providers_microsoft_entra_groups_list) | **GET** /providers/microsoft_entra_groups/ |
+*ProvidersApi* | [**providers_microsoft_entra_groups_retrieve**](docs/ProvidersApi.md#providers_microsoft_entra_groups_retrieve) | **GET** /providers/microsoft_entra_groups/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_groups_used_by_list**](docs/ProvidersApi.md#providers_microsoft_entra_groups_used_by_list) | **GET** /providers/microsoft_entra_groups/{id}/used_by/ |
+*ProvidersApi* | [**providers_microsoft_entra_list**](docs/ProvidersApi.md#providers_microsoft_entra_list) | **GET** /providers/microsoft_entra/ |
+*ProvidersApi* | [**providers_microsoft_entra_partial_update**](docs/ProvidersApi.md#providers_microsoft_entra_partial_update) | **PATCH** /providers/microsoft_entra/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_retrieve**](docs/ProvidersApi.md#providers_microsoft_entra_retrieve) | **GET** /providers/microsoft_entra/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_sync_object_create**](docs/ProvidersApi.md#providers_microsoft_entra_sync_object_create) | **POST** /providers/microsoft_entra/{id}/sync/object/ |
+*ProvidersApi* | [**providers_microsoft_entra_sync_status_retrieve**](docs/ProvidersApi.md#providers_microsoft_entra_sync_status_retrieve) | **GET** /providers/microsoft_entra/{id}/sync/status/ |
+*ProvidersApi* | [**providers_microsoft_entra_update**](docs/ProvidersApi.md#providers_microsoft_entra_update) | **PUT** /providers/microsoft_entra/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_used_by_list**](docs/ProvidersApi.md#providers_microsoft_entra_used_by_list) | **GET** /providers/microsoft_entra/{id}/used_by/ |
+*ProvidersApi* | [**providers_microsoft_entra_users_create**](docs/ProvidersApi.md#providers_microsoft_entra_users_create) | **POST** /providers/microsoft_entra_users/ |
+*ProvidersApi* | [**providers_microsoft_entra_users_destroy**](docs/ProvidersApi.md#providers_microsoft_entra_users_destroy) | **DELETE** /providers/microsoft_entra_users/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_users_list**](docs/ProvidersApi.md#providers_microsoft_entra_users_list) | **GET** /providers/microsoft_entra_users/ |
+*ProvidersApi* | [**providers_microsoft_entra_users_retrieve**](docs/ProvidersApi.md#providers_microsoft_entra_users_retrieve) | **GET** /providers/microsoft_entra_users/{id}/ |
+*ProvidersApi* | [**providers_microsoft_entra_users_used_by_list**](docs/ProvidersApi.md#providers_microsoft_entra_users_used_by_list) | **GET** /providers/microsoft_entra_users/{id}/used_by/ |
+*ProvidersApi* | [**providers_oauth2_create**](docs/ProvidersApi.md#providers_oauth2_create) | **POST** /providers/oauth2/ |
+*ProvidersApi* | [**providers_oauth2_destroy**](docs/ProvidersApi.md#providers_oauth2_destroy) | **DELETE** /providers/oauth2/{id}/ |
+*ProvidersApi* | [**providers_oauth2_list**](docs/ProvidersApi.md#providers_oauth2_list) | **GET** /providers/oauth2/ |
+*ProvidersApi* | [**providers_oauth2_partial_update**](docs/ProvidersApi.md#providers_oauth2_partial_update) | **PATCH** /providers/oauth2/{id}/ |
+*ProvidersApi* | [**providers_oauth2_preview_user_retrieve**](docs/ProvidersApi.md#providers_oauth2_preview_user_retrieve) | **GET** /providers/oauth2/{id}/preview_user/ |
+*ProvidersApi* | [**providers_oauth2_retrieve**](docs/ProvidersApi.md#providers_oauth2_retrieve) | **GET** /providers/oauth2/{id}/ |
+*ProvidersApi* | [**providers_oauth2_setup_urls_retrieve**](docs/ProvidersApi.md#providers_oauth2_setup_urls_retrieve) | **GET** /providers/oauth2/{id}/setup_urls/ |
+*ProvidersApi* | [**providers_oauth2_update**](docs/ProvidersApi.md#providers_oauth2_update) | **PUT** /providers/oauth2/{id}/ |
+*ProvidersApi* | [**providers_oauth2_used_by_list**](docs/ProvidersApi.md#providers_oauth2_used_by_list) | **GET** /providers/oauth2/{id}/used_by/ |
+*ProvidersApi* | [**providers_proxy_create**](docs/ProvidersApi.md#providers_proxy_create) | **POST** /providers/proxy/ |
+*ProvidersApi* | [**providers_proxy_destroy**](docs/ProvidersApi.md#providers_proxy_destroy) | **DELETE** /providers/proxy/{id}/ |
+*ProvidersApi* | [**providers_proxy_list**](docs/ProvidersApi.md#providers_proxy_list) | **GET** /providers/proxy/ |
+*ProvidersApi* | [**providers_proxy_partial_update**](docs/ProvidersApi.md#providers_proxy_partial_update) | **PATCH** /providers/proxy/{id}/ |
+*ProvidersApi* | [**providers_proxy_retrieve**](docs/ProvidersApi.md#providers_proxy_retrieve) | **GET** /providers/proxy/{id}/ |
+*ProvidersApi* | [**providers_proxy_update**](docs/ProvidersApi.md#providers_proxy_update) | **PUT** /providers/proxy/{id}/ |
+*ProvidersApi* | [**providers_proxy_used_by_list**](docs/ProvidersApi.md#providers_proxy_used_by_list) | **GET** /providers/proxy/{id}/used_by/ |
+*ProvidersApi* | [**providers_rac_create**](docs/ProvidersApi.md#providers_rac_create) | **POST** /providers/rac/ |
+*ProvidersApi* | [**providers_rac_destroy**](docs/ProvidersApi.md#providers_rac_destroy) | **DELETE** /providers/rac/{id}/ |
+*ProvidersApi* | [**providers_rac_list**](docs/ProvidersApi.md#providers_rac_list) | **GET** /providers/rac/ |
+*ProvidersApi* | [**providers_rac_partial_update**](docs/ProvidersApi.md#providers_rac_partial_update) | **PATCH** /providers/rac/{id}/ |
+*ProvidersApi* | [**providers_rac_retrieve**](docs/ProvidersApi.md#providers_rac_retrieve) | **GET** /providers/rac/{id}/ |
+*ProvidersApi* | [**providers_rac_update**](docs/ProvidersApi.md#providers_rac_update) | **PUT** /providers/rac/{id}/ |
+*ProvidersApi* | [**providers_rac_used_by_list**](docs/ProvidersApi.md#providers_rac_used_by_list) | **GET** /providers/rac/{id}/used_by/ |
+*ProvidersApi* | [**providers_radius_create**](docs/ProvidersApi.md#providers_radius_create) | **POST** /providers/radius/ |
+*ProvidersApi* | [**providers_radius_destroy**](docs/ProvidersApi.md#providers_radius_destroy) | **DELETE** /providers/radius/{id}/ |
+*ProvidersApi* | [**providers_radius_list**](docs/ProvidersApi.md#providers_radius_list) | **GET** /providers/radius/ |
+*ProvidersApi* | [**providers_radius_partial_update**](docs/ProvidersApi.md#providers_radius_partial_update) | **PATCH** /providers/radius/{id}/ |
+*ProvidersApi* | [**providers_radius_retrieve**](docs/ProvidersApi.md#providers_radius_retrieve) | **GET** /providers/radius/{id}/ |
+*ProvidersApi* | [**providers_radius_update**](docs/ProvidersApi.md#providers_radius_update) | **PUT** /providers/radius/{id}/ |
+*ProvidersApi* | [**providers_radius_used_by_list**](docs/ProvidersApi.md#providers_radius_used_by_list) | **GET** /providers/radius/{id}/used_by/ |
+*ProvidersApi* | [**providers_saml_create**](docs/ProvidersApi.md#providers_saml_create) | **POST** /providers/saml/ |
+*ProvidersApi* | [**providers_saml_destroy**](docs/ProvidersApi.md#providers_saml_destroy) | **DELETE** /providers/saml/{id}/ |
+*ProvidersApi* | [**providers_saml_import_metadata_create**](docs/ProvidersApi.md#providers_saml_import_metadata_create) | **POST** /providers/saml/import_metadata/ |
+*ProvidersApi* | [**providers_saml_list**](docs/ProvidersApi.md#providers_saml_list) | **GET** /providers/saml/ |
+*ProvidersApi* | [**providers_saml_metadata_retrieve**](docs/ProvidersApi.md#providers_saml_metadata_retrieve) | **GET** /providers/saml/{id}/metadata/ |
+*ProvidersApi* | [**providers_saml_partial_update**](docs/ProvidersApi.md#providers_saml_partial_update) | **PATCH** /providers/saml/{id}/ |
+*ProvidersApi* | [**providers_saml_preview_user_retrieve**](docs/ProvidersApi.md#providers_saml_preview_user_retrieve) | **GET** /providers/saml/{id}/preview_user/ |
+*ProvidersApi* | [**providers_saml_retrieve**](docs/ProvidersApi.md#providers_saml_retrieve) | **GET** /providers/saml/{id}/ |
+*ProvidersApi* | [**providers_saml_update**](docs/ProvidersApi.md#providers_saml_update) | **PUT** /providers/saml/{id}/ |
+*ProvidersApi* | [**providers_saml_used_by_list**](docs/ProvidersApi.md#providers_saml_used_by_list) | **GET** /providers/saml/{id}/used_by/ |
+*ProvidersApi* | [**providers_scim_create**](docs/ProvidersApi.md#providers_scim_create) | **POST** /providers/scim/ |
+*ProvidersApi* | [**providers_scim_destroy**](docs/ProvidersApi.md#providers_scim_destroy) | **DELETE** /providers/scim/{id}/ |
+*ProvidersApi* | [**providers_scim_groups_create**](docs/ProvidersApi.md#providers_scim_groups_create) | **POST** /providers/scim_groups/ |
+*ProvidersApi* | [**providers_scim_groups_destroy**](docs/ProvidersApi.md#providers_scim_groups_destroy) | **DELETE** /providers/scim_groups/{id}/ |
+*ProvidersApi* | [**providers_scim_groups_list**](docs/ProvidersApi.md#providers_scim_groups_list) | **GET** /providers/scim_groups/ |
+*ProvidersApi* | [**providers_scim_groups_retrieve**](docs/ProvidersApi.md#providers_scim_groups_retrieve) | **GET** /providers/scim_groups/{id}/ |
+*ProvidersApi* | [**providers_scim_groups_used_by_list**](docs/ProvidersApi.md#providers_scim_groups_used_by_list) | **GET** /providers/scim_groups/{id}/used_by/ |
+*ProvidersApi* | [**providers_scim_list**](docs/ProvidersApi.md#providers_scim_list) | **GET** /providers/scim/ |
+*ProvidersApi* | [**providers_scim_partial_update**](docs/ProvidersApi.md#providers_scim_partial_update) | **PATCH** /providers/scim/{id}/ |
+*ProvidersApi* | [**providers_scim_retrieve**](docs/ProvidersApi.md#providers_scim_retrieve) | **GET** /providers/scim/{id}/ |
+*ProvidersApi* | [**providers_scim_sync_object_create**](docs/ProvidersApi.md#providers_scim_sync_object_create) | **POST** /providers/scim/{id}/sync/object/ |
+*ProvidersApi* | [**providers_scim_sync_status_retrieve**](docs/ProvidersApi.md#providers_scim_sync_status_retrieve) | **GET** /providers/scim/{id}/sync/status/ |
+*ProvidersApi* | [**providers_scim_update**](docs/ProvidersApi.md#providers_scim_update) | **PUT** /providers/scim/{id}/ |
+*ProvidersApi* | [**providers_scim_used_by_list**](docs/ProvidersApi.md#providers_scim_used_by_list) | **GET** /providers/scim/{id}/used_by/ |
+*ProvidersApi* | [**providers_scim_users_create**](docs/ProvidersApi.md#providers_scim_users_create) | **POST** /providers/scim_users/ |
+*ProvidersApi* | [**providers_scim_users_destroy**](docs/ProvidersApi.md#providers_scim_users_destroy) | **DELETE** /providers/scim_users/{id}/ |
+*ProvidersApi* | [**providers_scim_users_list**](docs/ProvidersApi.md#providers_scim_users_list) | **GET** /providers/scim_users/ |
+*ProvidersApi* | [**providers_scim_users_retrieve**](docs/ProvidersApi.md#providers_scim_users_retrieve) | **GET** /providers/scim_users/{id}/ |
+*ProvidersApi* | [**providers_scim_users_used_by_list**](docs/ProvidersApi.md#providers_scim_users_used_by_list) | **GET** /providers/scim_users/{id}/used_by/ |
+*ProvidersApi* | [**providers_ssf_create**](docs/ProvidersApi.md#providers_ssf_create) | **POST** /providers/ssf/ |
+*ProvidersApi* | [**providers_ssf_destroy**](docs/ProvidersApi.md#providers_ssf_destroy) | **DELETE** /providers/ssf/{id}/ |
+*ProvidersApi* | [**providers_ssf_list**](docs/ProvidersApi.md#providers_ssf_list) | **GET** /providers/ssf/ |
+*ProvidersApi* | [**providers_ssf_partial_update**](docs/ProvidersApi.md#providers_ssf_partial_update) | **PATCH** /providers/ssf/{id}/ |
+*ProvidersApi* | [**providers_ssf_retrieve**](docs/ProvidersApi.md#providers_ssf_retrieve) | **GET** /providers/ssf/{id}/ |
+*ProvidersApi* | [**providers_ssf_update**](docs/ProvidersApi.md#providers_ssf_update) | **PUT** /providers/ssf/{id}/ |
+*ProvidersApi* | [**providers_ssf_used_by_list**](docs/ProvidersApi.md#providers_ssf_used_by_list) | **GET** /providers/ssf/{id}/used_by/ |
+*ProvidersApi* | [**providers_wsfed_create**](docs/ProvidersApi.md#providers_wsfed_create) | **POST** /providers/wsfed/ |
+*ProvidersApi* | [**providers_wsfed_destroy**](docs/ProvidersApi.md#providers_wsfed_destroy) | **DELETE** /providers/wsfed/{id}/ |
+*ProvidersApi* | [**providers_wsfed_list**](docs/ProvidersApi.md#providers_wsfed_list) | **GET** /providers/wsfed/ |
+*ProvidersApi* | [**providers_wsfed_metadata_retrieve**](docs/ProvidersApi.md#providers_wsfed_metadata_retrieve) | **GET** /providers/wsfed/{id}/metadata/ |
+*ProvidersApi* | [**providers_wsfed_partial_update**](docs/ProvidersApi.md#providers_wsfed_partial_update) | **PATCH** /providers/wsfed/{id}/ |
+*ProvidersApi* | [**providers_wsfed_preview_user_retrieve**](docs/ProvidersApi.md#providers_wsfed_preview_user_retrieve) | **GET** /providers/wsfed/{id}/preview_user/ |
+*ProvidersApi* | [**providers_wsfed_retrieve**](docs/ProvidersApi.md#providers_wsfed_retrieve) | **GET** /providers/wsfed/{id}/ |
+*ProvidersApi* | [**providers_wsfed_update**](docs/ProvidersApi.md#providers_wsfed_update) | **PUT** /providers/wsfed/{id}/ |
+*ProvidersApi* | [**providers_wsfed_used_by_list**](docs/ProvidersApi.md#providers_wsfed_used_by_list) | **GET** /providers/wsfed/{id}/used_by/ |
+*RacApi* | [**rac_connection_tokens_destroy**](docs/RacApi.md#rac_connection_tokens_destroy) | **DELETE** /rac/connection_tokens/{connection_token_uuid}/ |
+*RacApi* | [**rac_connection_tokens_list**](docs/RacApi.md#rac_connection_tokens_list) | **GET** /rac/connection_tokens/ |
+*RacApi* | [**rac_connection_tokens_partial_update**](docs/RacApi.md#rac_connection_tokens_partial_update) | **PATCH** /rac/connection_tokens/{connection_token_uuid}/ |
+*RacApi* | [**rac_connection_tokens_retrieve**](docs/RacApi.md#rac_connection_tokens_retrieve) | **GET** /rac/connection_tokens/{connection_token_uuid}/ |
+*RacApi* | [**rac_connection_tokens_update**](docs/RacApi.md#rac_connection_tokens_update) | **PUT** /rac/connection_tokens/{connection_token_uuid}/ |
+*RacApi* | [**rac_connection_tokens_used_by_list**](docs/RacApi.md#rac_connection_tokens_used_by_list) | **GET** /rac/connection_tokens/{connection_token_uuid}/used_by/ |
+*RacApi* | [**rac_endpoints_create**](docs/RacApi.md#rac_endpoints_create) | **POST** /rac/endpoints/ |
+*RacApi* | [**rac_endpoints_destroy**](docs/RacApi.md#rac_endpoints_destroy) | **DELETE** /rac/endpoints/{pbm_uuid}/ |
+*RacApi* | [**rac_endpoints_list**](docs/RacApi.md#rac_endpoints_list) | **GET** /rac/endpoints/ |
+*RacApi* | [**rac_endpoints_partial_update**](docs/RacApi.md#rac_endpoints_partial_update) | **PATCH** /rac/endpoints/{pbm_uuid}/ |
+*RacApi* | [**rac_endpoints_retrieve**](docs/RacApi.md#rac_endpoints_retrieve) | **GET** /rac/endpoints/{pbm_uuid}/ |
+*RacApi* | [**rac_endpoints_update**](docs/RacApi.md#rac_endpoints_update) | **PUT** /rac/endpoints/{pbm_uuid}/ |
+*RacApi* | [**rac_endpoints_used_by_list**](docs/RacApi.md#rac_endpoints_used_by_list) | **GET** /rac/endpoints/{pbm_uuid}/used_by/ |
+*RbacApi* | [**rbac_initial_permissions_create**](docs/RbacApi.md#rbac_initial_permissions_create) | **POST** /rbac/initial_permissions/ |
+*RbacApi* | [**rbac_initial_permissions_destroy**](docs/RbacApi.md#rbac_initial_permissions_destroy) | **DELETE** /rbac/initial_permissions/{id}/ |
+*RbacApi* | [**rbac_initial_permissions_list**](docs/RbacApi.md#rbac_initial_permissions_list) | **GET** /rbac/initial_permissions/ |
+*RbacApi* | [**rbac_initial_permissions_partial_update**](docs/RbacApi.md#rbac_initial_permissions_partial_update) | **PATCH** /rbac/initial_permissions/{id}/ |
+*RbacApi* | [**rbac_initial_permissions_retrieve**](docs/RbacApi.md#rbac_initial_permissions_retrieve) | **GET** /rbac/initial_permissions/{id}/ |
+*RbacApi* | [**rbac_initial_permissions_update**](docs/RbacApi.md#rbac_initial_permissions_update) | **PUT** /rbac/initial_permissions/{id}/ |
+*RbacApi* | [**rbac_initial_permissions_used_by_list**](docs/RbacApi.md#rbac_initial_permissions_used_by_list) | **GET** /rbac/initial_permissions/{id}/used_by/ |
+*RbacApi* | [**rbac_permissions_assigned_by_roles_assign**](docs/RbacApi.md#rbac_permissions_assigned_by_roles_assign) | **POST** /rbac/permissions/assigned_by_roles/{uuid}/assign/ |
+*RbacApi* | [**rbac_permissions_assigned_by_roles_list**](docs/RbacApi.md#rbac_permissions_assigned_by_roles_list) | **GET** /rbac/permissions/assigned_by_roles/ |
+*RbacApi* | [**rbac_permissions_assigned_by_roles_unassign_partial_update**](docs/RbacApi.md#rbac_permissions_assigned_by_roles_unassign_partial_update) | **PATCH** /rbac/permissions/assigned_by_roles/{uuid}/unassign/ |
+*RbacApi* | [**rbac_permissions_list**](docs/RbacApi.md#rbac_permissions_list) | **GET** /rbac/permissions/ |
+*RbacApi* | [**rbac_permissions_retrieve**](docs/RbacApi.md#rbac_permissions_retrieve) | **GET** /rbac/permissions/{id}/ |
+*RbacApi* | [**rbac_permissions_roles_list**](docs/RbacApi.md#rbac_permissions_roles_list) | **GET** /rbac/permissions/roles/ |
+*RbacApi* | [**rbac_roles_add_user_create**](docs/RbacApi.md#rbac_roles_add_user_create) | **POST** /rbac/roles/{uuid}/add_user/ |
+*RbacApi* | [**rbac_roles_create**](docs/RbacApi.md#rbac_roles_create) | **POST** /rbac/roles/ |
+*RbacApi* | [**rbac_roles_destroy**](docs/RbacApi.md#rbac_roles_destroy) | **DELETE** /rbac/roles/{uuid}/ |
+*RbacApi* | [**rbac_roles_list**](docs/RbacApi.md#rbac_roles_list) | **GET** /rbac/roles/ |
+*RbacApi* | [**rbac_roles_partial_update**](docs/RbacApi.md#rbac_roles_partial_update) | **PATCH** /rbac/roles/{uuid}/ |
+*RbacApi* | [**rbac_roles_remove_user_create**](docs/RbacApi.md#rbac_roles_remove_user_create) | **POST** /rbac/roles/{uuid}/remove_user/ |
+*RbacApi* | [**rbac_roles_retrieve**](docs/RbacApi.md#rbac_roles_retrieve) | **GET** /rbac/roles/{uuid}/ |
+*RbacApi* | [**rbac_roles_update**](docs/RbacApi.md#rbac_roles_update) | **PUT** /rbac/roles/{uuid}/ |
+*RbacApi* | [**rbac_roles_used_by_list**](docs/RbacApi.md#rbac_roles_used_by_list) | **GET** /rbac/roles/{uuid}/used_by/ |
+*ReportsApi* | [**reports_exports_destroy**](docs/ReportsApi.md#reports_exports_destroy) | **DELETE** /reports/exports/{id}/ |
+*ReportsApi* | [**reports_exports_list**](docs/ReportsApi.md#reports_exports_list) | **GET** /reports/exports/ |
+*ReportsApi* | [**reports_exports_retrieve**](docs/ReportsApi.md#reports_exports_retrieve) | **GET** /reports/exports/{id}/ |
+*RootApi* | [**root_config_retrieve**](docs/RootApi.md#root_config_retrieve) | **GET** /root/config/ |
+*SchemaApi* | [**schema_retrieve**](docs/SchemaApi.md#schema_retrieve) | **GET** /schema/ |
+*SourcesApi* | [**sources_all_destroy**](docs/SourcesApi.md#sources_all_destroy) | **DELETE** /sources/all/{slug}/ |
+*SourcesApi* | [**sources_all_list**](docs/SourcesApi.md#sources_all_list) | **GET** /sources/all/ |
+*SourcesApi* | [**sources_all_retrieve**](docs/SourcesApi.md#sources_all_retrieve) | **GET** /sources/all/{slug}/ |
+*SourcesApi* | [**sources_all_types_list**](docs/SourcesApi.md#sources_all_types_list) | **GET** /sources/all/types/ |
+*SourcesApi* | [**sources_all_used_by_list**](docs/SourcesApi.md#sources_all_used_by_list) | **GET** /sources/all/{slug}/used_by/ |
+*SourcesApi* | [**sources_all_user_settings_list**](docs/SourcesApi.md#sources_all_user_settings_list) | **GET** /sources/all/user_settings/ |
+*SourcesApi* | [**sources_group_connections_all_destroy**](docs/SourcesApi.md#sources_group_connections_all_destroy) | **DELETE** /sources/group_connections/all/{id}/ |
+*SourcesApi* | [**sources_group_connections_all_list**](docs/SourcesApi.md#sources_group_connections_all_list) | **GET** /sources/group_connections/all/ |
+*SourcesApi* | [**sources_group_connections_all_partial_update**](docs/SourcesApi.md#sources_group_connections_all_partial_update) | **PATCH** /sources/group_connections/all/{id}/ |
+*SourcesApi* | [**sources_group_connections_all_retrieve**](docs/SourcesApi.md#sources_group_connections_all_retrieve) | **GET** /sources/group_connections/all/{id}/ |
+*SourcesApi* | [**sources_group_connections_all_update**](docs/SourcesApi.md#sources_group_connections_all_update) | **PUT** /sources/group_connections/all/{id}/ |
+*SourcesApi* | [**sources_group_connections_all_used_by_list**](docs/SourcesApi.md#sources_group_connections_all_used_by_list) | **GET** /sources/group_connections/all/{id}/used_by/ |
+*SourcesApi* | [**sources_group_connections_kerberos_create**](docs/SourcesApi.md#sources_group_connections_kerberos_create) | **POST** /sources/group_connections/kerberos/ |
+*SourcesApi* | [**sources_group_connections_kerberos_destroy**](docs/SourcesApi.md#sources_group_connections_kerberos_destroy) | **DELETE** /sources/group_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_group_connections_kerberos_list**](docs/SourcesApi.md#sources_group_connections_kerberos_list) | **GET** /sources/group_connections/kerberos/ |
+*SourcesApi* | [**sources_group_connections_kerberos_partial_update**](docs/SourcesApi.md#sources_group_connections_kerberos_partial_update) | **PATCH** /sources/group_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_group_connections_kerberos_retrieve**](docs/SourcesApi.md#sources_group_connections_kerberos_retrieve) | **GET** /sources/group_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_group_connections_kerberos_update**](docs/SourcesApi.md#sources_group_connections_kerberos_update) | **PUT** /sources/group_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_group_connections_kerberos_used_by_list**](docs/SourcesApi.md#sources_group_connections_kerberos_used_by_list) | **GET** /sources/group_connections/kerberos/{id}/used_by/ |
+*SourcesApi* | [**sources_group_connections_ldap_create**](docs/SourcesApi.md#sources_group_connections_ldap_create) | **POST** /sources/group_connections/ldap/ |
+*SourcesApi* | [**sources_group_connections_ldap_destroy**](docs/SourcesApi.md#sources_group_connections_ldap_destroy) | **DELETE** /sources/group_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_group_connections_ldap_list**](docs/SourcesApi.md#sources_group_connections_ldap_list) | **GET** /sources/group_connections/ldap/ |
+*SourcesApi* | [**sources_group_connections_ldap_partial_update**](docs/SourcesApi.md#sources_group_connections_ldap_partial_update) | **PATCH** /sources/group_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_group_connections_ldap_retrieve**](docs/SourcesApi.md#sources_group_connections_ldap_retrieve) | **GET** /sources/group_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_group_connections_ldap_update**](docs/SourcesApi.md#sources_group_connections_ldap_update) | **PUT** /sources/group_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_group_connections_ldap_used_by_list**](docs/SourcesApi.md#sources_group_connections_ldap_used_by_list) | **GET** /sources/group_connections/ldap/{id}/used_by/ |
+*SourcesApi* | [**sources_group_connections_oauth_create**](docs/SourcesApi.md#sources_group_connections_oauth_create) | **POST** /sources/group_connections/oauth/ |
+*SourcesApi* | [**sources_group_connections_oauth_destroy**](docs/SourcesApi.md#sources_group_connections_oauth_destroy) | **DELETE** /sources/group_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_group_connections_oauth_list**](docs/SourcesApi.md#sources_group_connections_oauth_list) | **GET** /sources/group_connections/oauth/ |
+*SourcesApi* | [**sources_group_connections_oauth_partial_update**](docs/SourcesApi.md#sources_group_connections_oauth_partial_update) | **PATCH** /sources/group_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_group_connections_oauth_retrieve**](docs/SourcesApi.md#sources_group_connections_oauth_retrieve) | **GET** /sources/group_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_group_connections_oauth_update**](docs/SourcesApi.md#sources_group_connections_oauth_update) | **PUT** /sources/group_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_group_connections_oauth_used_by_list**](docs/SourcesApi.md#sources_group_connections_oauth_used_by_list) | **GET** /sources/group_connections/oauth/{id}/used_by/ |
+*SourcesApi* | [**sources_group_connections_plex_create**](docs/SourcesApi.md#sources_group_connections_plex_create) | **POST** /sources/group_connections/plex/ |
+*SourcesApi* | [**sources_group_connections_plex_destroy**](docs/SourcesApi.md#sources_group_connections_plex_destroy) | **DELETE** /sources/group_connections/plex/{id}/ |
+*SourcesApi* | [**sources_group_connections_plex_list**](docs/SourcesApi.md#sources_group_connections_plex_list) | **GET** /sources/group_connections/plex/ |
+*SourcesApi* | [**sources_group_connections_plex_partial_update**](docs/SourcesApi.md#sources_group_connections_plex_partial_update) | **PATCH** /sources/group_connections/plex/{id}/ |
+*SourcesApi* | [**sources_group_connections_plex_retrieve**](docs/SourcesApi.md#sources_group_connections_plex_retrieve) | **GET** /sources/group_connections/plex/{id}/ |
+*SourcesApi* | [**sources_group_connections_plex_update**](docs/SourcesApi.md#sources_group_connections_plex_update) | **PUT** /sources/group_connections/plex/{id}/ |
+*SourcesApi* | [**sources_group_connections_plex_used_by_list**](docs/SourcesApi.md#sources_group_connections_plex_used_by_list) | **GET** /sources/group_connections/plex/{id}/used_by/ |
+*SourcesApi* | [**sources_group_connections_saml_create**](docs/SourcesApi.md#sources_group_connections_saml_create) | **POST** /sources/group_connections/saml/ |
+*SourcesApi* | [**sources_group_connections_saml_destroy**](docs/SourcesApi.md#sources_group_connections_saml_destroy) | **DELETE** /sources/group_connections/saml/{id}/ |
+*SourcesApi* | [**sources_group_connections_saml_list**](docs/SourcesApi.md#sources_group_connections_saml_list) | **GET** /sources/group_connections/saml/ |
+*SourcesApi* | [**sources_group_connections_saml_partial_update**](docs/SourcesApi.md#sources_group_connections_saml_partial_update) | **PATCH** /sources/group_connections/saml/{id}/ |
+*SourcesApi* | [**sources_group_connections_saml_retrieve**](docs/SourcesApi.md#sources_group_connections_saml_retrieve) | **GET** /sources/group_connections/saml/{id}/ |
+*SourcesApi* | [**sources_group_connections_saml_update**](docs/SourcesApi.md#sources_group_connections_saml_update) | **PUT** /sources/group_connections/saml/{id}/ |
+*SourcesApi* | [**sources_group_connections_saml_used_by_list**](docs/SourcesApi.md#sources_group_connections_saml_used_by_list) | **GET** /sources/group_connections/saml/{id}/used_by/ |
+*SourcesApi* | [**sources_group_connections_telegram_create**](docs/SourcesApi.md#sources_group_connections_telegram_create) | **POST** /sources/group_connections/telegram/ |
+*SourcesApi* | [**sources_group_connections_telegram_destroy**](docs/SourcesApi.md#sources_group_connections_telegram_destroy) | **DELETE** /sources/group_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_group_connections_telegram_list**](docs/SourcesApi.md#sources_group_connections_telegram_list) | **GET** /sources/group_connections/telegram/ |
+*SourcesApi* | [**sources_group_connections_telegram_partial_update**](docs/SourcesApi.md#sources_group_connections_telegram_partial_update) | **PATCH** /sources/group_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_group_connections_telegram_retrieve**](docs/SourcesApi.md#sources_group_connections_telegram_retrieve) | **GET** /sources/group_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_group_connections_telegram_update**](docs/SourcesApi.md#sources_group_connections_telegram_update) | **PUT** /sources/group_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_group_connections_telegram_used_by_list**](docs/SourcesApi.md#sources_group_connections_telegram_used_by_list) | **GET** /sources/group_connections/telegram/{id}/used_by/ |
+*SourcesApi* | [**sources_kerberos_create**](docs/SourcesApi.md#sources_kerberos_create) | **POST** /sources/kerberos/ |
+*SourcesApi* | [**sources_kerberos_destroy**](docs/SourcesApi.md#sources_kerberos_destroy) | **DELETE** /sources/kerberos/{slug}/ |
+*SourcesApi* | [**sources_kerberos_list**](docs/SourcesApi.md#sources_kerberos_list) | **GET** /sources/kerberos/ |
+*SourcesApi* | [**sources_kerberos_partial_update**](docs/SourcesApi.md#sources_kerberos_partial_update) | **PATCH** /sources/kerberos/{slug}/ |
+*SourcesApi* | [**sources_kerberos_retrieve**](docs/SourcesApi.md#sources_kerberos_retrieve) | **GET** /sources/kerberos/{slug}/ |
+*SourcesApi* | [**sources_kerberos_sync_status_retrieve**](docs/SourcesApi.md#sources_kerberos_sync_status_retrieve) | **GET** /sources/kerberos/{slug}/sync/status/ |
+*SourcesApi* | [**sources_kerberos_update**](docs/SourcesApi.md#sources_kerberos_update) | **PUT** /sources/kerberos/{slug}/ |
+*SourcesApi* | [**sources_kerberos_used_by_list**](docs/SourcesApi.md#sources_kerberos_used_by_list) | **GET** /sources/kerberos/{slug}/used_by/ |
+*SourcesApi* | [**sources_ldap_create**](docs/SourcesApi.md#sources_ldap_create) | **POST** /sources/ldap/ |
+*SourcesApi* | [**sources_ldap_debug_retrieve**](docs/SourcesApi.md#sources_ldap_debug_retrieve) | **GET** /sources/ldap/{slug}/debug/ |
+*SourcesApi* | [**sources_ldap_destroy**](docs/SourcesApi.md#sources_ldap_destroy) | **DELETE** /sources/ldap/{slug}/ |
+*SourcesApi* | [**sources_ldap_list**](docs/SourcesApi.md#sources_ldap_list) | **GET** /sources/ldap/ |
+*SourcesApi* | [**sources_ldap_partial_update**](docs/SourcesApi.md#sources_ldap_partial_update) | **PATCH** /sources/ldap/{slug}/ |
+*SourcesApi* | [**sources_ldap_retrieve**](docs/SourcesApi.md#sources_ldap_retrieve) | **GET** /sources/ldap/{slug}/ |
+*SourcesApi* | [**sources_ldap_sync_status_retrieve**](docs/SourcesApi.md#sources_ldap_sync_status_retrieve) | **GET** /sources/ldap/{slug}/sync/status/ |
+*SourcesApi* | [**sources_ldap_update**](docs/SourcesApi.md#sources_ldap_update) | **PUT** /sources/ldap/{slug}/ |
+*SourcesApi* | [**sources_ldap_used_by_list**](docs/SourcesApi.md#sources_ldap_used_by_list) | **GET** /sources/ldap/{slug}/used_by/ |
+*SourcesApi* | [**sources_oauth_create**](docs/SourcesApi.md#sources_oauth_create) | **POST** /sources/oauth/ |
+*SourcesApi* | [**sources_oauth_destroy**](docs/SourcesApi.md#sources_oauth_destroy) | **DELETE** /sources/oauth/{slug}/ |
+*SourcesApi* | [**sources_oauth_list**](docs/SourcesApi.md#sources_oauth_list) | **GET** /sources/oauth/ |
+*SourcesApi* | [**sources_oauth_partial_update**](docs/SourcesApi.md#sources_oauth_partial_update) | **PATCH** /sources/oauth/{slug}/ |
+*SourcesApi* | [**sources_oauth_retrieve**](docs/SourcesApi.md#sources_oauth_retrieve) | **GET** /sources/oauth/{slug}/ |
+*SourcesApi* | [**sources_oauth_source_types_list**](docs/SourcesApi.md#sources_oauth_source_types_list) | **GET** /sources/oauth/source_types/ |
+*SourcesApi* | [**sources_oauth_update**](docs/SourcesApi.md#sources_oauth_update) | **PUT** /sources/oauth/{slug}/ |
+*SourcesApi* | [**sources_oauth_used_by_list**](docs/SourcesApi.md#sources_oauth_used_by_list) | **GET** /sources/oauth/{slug}/used_by/ |
+*SourcesApi* | [**sources_plex_create**](docs/SourcesApi.md#sources_plex_create) | **POST** /sources/plex/ |
+*SourcesApi* | [**sources_plex_destroy**](docs/SourcesApi.md#sources_plex_destroy) | **DELETE** /sources/plex/{slug}/ |
+*SourcesApi* | [**sources_plex_list**](docs/SourcesApi.md#sources_plex_list) | **GET** /sources/plex/ |
+*SourcesApi* | [**sources_plex_partial_update**](docs/SourcesApi.md#sources_plex_partial_update) | **PATCH** /sources/plex/{slug}/ |
+*SourcesApi* | [**sources_plex_redeem_token_authenticated_create**](docs/SourcesApi.md#sources_plex_redeem_token_authenticated_create) | **POST** /sources/plex/redeem_token_authenticated/ |
+*SourcesApi* | [**sources_plex_redeem_token_create**](docs/SourcesApi.md#sources_plex_redeem_token_create) | **POST** /sources/plex/redeem_token/ |
+*SourcesApi* | [**sources_plex_retrieve**](docs/SourcesApi.md#sources_plex_retrieve) | **GET** /sources/plex/{slug}/ |
+*SourcesApi* | [**sources_plex_update**](docs/SourcesApi.md#sources_plex_update) | **PUT** /sources/plex/{slug}/ |
+*SourcesApi* | [**sources_plex_used_by_list**](docs/SourcesApi.md#sources_plex_used_by_list) | **GET** /sources/plex/{slug}/used_by/ |
+*SourcesApi* | [**sources_saml_create**](docs/SourcesApi.md#sources_saml_create) | **POST** /sources/saml/ |
+*SourcesApi* | [**sources_saml_destroy**](docs/SourcesApi.md#sources_saml_destroy) | **DELETE** /sources/saml/{slug}/ |
+*SourcesApi* | [**sources_saml_list**](docs/SourcesApi.md#sources_saml_list) | **GET** /sources/saml/ |
+*SourcesApi* | [**sources_saml_metadata_retrieve**](docs/SourcesApi.md#sources_saml_metadata_retrieve) | **GET** /sources/saml/{slug}/metadata/ |
+*SourcesApi* | [**sources_saml_partial_update**](docs/SourcesApi.md#sources_saml_partial_update) | **PATCH** /sources/saml/{slug}/ |
+*SourcesApi* | [**sources_saml_retrieve**](docs/SourcesApi.md#sources_saml_retrieve) | **GET** /sources/saml/{slug}/ |
+*SourcesApi* | [**sources_saml_update**](docs/SourcesApi.md#sources_saml_update) | **PUT** /sources/saml/{slug}/ |
+*SourcesApi* | [**sources_saml_used_by_list**](docs/SourcesApi.md#sources_saml_used_by_list) | **GET** /sources/saml/{slug}/used_by/ |
+*SourcesApi* | [**sources_scim_create**](docs/SourcesApi.md#sources_scim_create) | **POST** /sources/scim/ |
+*SourcesApi* | [**sources_scim_destroy**](docs/SourcesApi.md#sources_scim_destroy) | **DELETE** /sources/scim/{slug}/ |
+*SourcesApi* | [**sources_scim_groups_create**](docs/SourcesApi.md#sources_scim_groups_create) | **POST** /sources/scim_groups/ |
+*SourcesApi* | [**sources_scim_groups_destroy**](docs/SourcesApi.md#sources_scim_groups_destroy) | **DELETE** /sources/scim_groups/{id}/ |
+*SourcesApi* | [**sources_scim_groups_list**](docs/SourcesApi.md#sources_scim_groups_list) | **GET** /sources/scim_groups/ |
+*SourcesApi* | [**sources_scim_groups_partial_update**](docs/SourcesApi.md#sources_scim_groups_partial_update) | **PATCH** /sources/scim_groups/{id}/ |
+*SourcesApi* | [**sources_scim_groups_retrieve**](docs/SourcesApi.md#sources_scim_groups_retrieve) | **GET** /sources/scim_groups/{id}/ |
+*SourcesApi* | [**sources_scim_groups_update**](docs/SourcesApi.md#sources_scim_groups_update) | **PUT** /sources/scim_groups/{id}/ |
+*SourcesApi* | [**sources_scim_groups_used_by_list**](docs/SourcesApi.md#sources_scim_groups_used_by_list) | **GET** /sources/scim_groups/{id}/used_by/ |
+*SourcesApi* | [**sources_scim_list**](docs/SourcesApi.md#sources_scim_list) | **GET** /sources/scim/ |
+*SourcesApi* | [**sources_scim_partial_update**](docs/SourcesApi.md#sources_scim_partial_update) | **PATCH** /sources/scim/{slug}/ |
+*SourcesApi* | [**sources_scim_retrieve**](docs/SourcesApi.md#sources_scim_retrieve) | **GET** /sources/scim/{slug}/ |
+*SourcesApi* | [**sources_scim_update**](docs/SourcesApi.md#sources_scim_update) | **PUT** /sources/scim/{slug}/ |
+*SourcesApi* | [**sources_scim_used_by_list**](docs/SourcesApi.md#sources_scim_used_by_list) | **GET** /sources/scim/{slug}/used_by/ |
+*SourcesApi* | [**sources_scim_users_create**](docs/SourcesApi.md#sources_scim_users_create) | **POST** /sources/scim_users/ |
+*SourcesApi* | [**sources_scim_users_destroy**](docs/SourcesApi.md#sources_scim_users_destroy) | **DELETE** /sources/scim_users/{id}/ |
+*SourcesApi* | [**sources_scim_users_list**](docs/SourcesApi.md#sources_scim_users_list) | **GET** /sources/scim_users/ |
+*SourcesApi* | [**sources_scim_users_partial_update**](docs/SourcesApi.md#sources_scim_users_partial_update) | **PATCH** /sources/scim_users/{id}/ |
+*SourcesApi* | [**sources_scim_users_retrieve**](docs/SourcesApi.md#sources_scim_users_retrieve) | **GET** /sources/scim_users/{id}/ |
+*SourcesApi* | [**sources_scim_users_update**](docs/SourcesApi.md#sources_scim_users_update) | **PUT** /sources/scim_users/{id}/ |
+*SourcesApi* | [**sources_scim_users_used_by_list**](docs/SourcesApi.md#sources_scim_users_used_by_list) | **GET** /sources/scim_users/{id}/used_by/ |
+*SourcesApi* | [**sources_telegram_connect_user_create**](docs/SourcesApi.md#sources_telegram_connect_user_create) | **POST** /sources/telegram/{slug}/connect_user/ |
+*SourcesApi* | [**sources_telegram_create**](docs/SourcesApi.md#sources_telegram_create) | **POST** /sources/telegram/ |
+*SourcesApi* | [**sources_telegram_destroy**](docs/SourcesApi.md#sources_telegram_destroy) | **DELETE** /sources/telegram/{slug}/ |
+*SourcesApi* | [**sources_telegram_list**](docs/SourcesApi.md#sources_telegram_list) | **GET** /sources/telegram/ |
+*SourcesApi* | [**sources_telegram_partial_update**](docs/SourcesApi.md#sources_telegram_partial_update) | **PATCH** /sources/telegram/{slug}/ |
+*SourcesApi* | [**sources_telegram_retrieve**](docs/SourcesApi.md#sources_telegram_retrieve) | **GET** /sources/telegram/{slug}/ |
+*SourcesApi* | [**sources_telegram_update**](docs/SourcesApi.md#sources_telegram_update) | **PUT** /sources/telegram/{slug}/ |
+*SourcesApi* | [**sources_telegram_used_by_list**](docs/SourcesApi.md#sources_telegram_used_by_list) | **GET** /sources/telegram/{slug}/used_by/ |
+*SourcesApi* | [**sources_user_connections_all_destroy**](docs/SourcesApi.md#sources_user_connections_all_destroy) | **DELETE** /sources/user_connections/all/{id}/ |
+*SourcesApi* | [**sources_user_connections_all_list**](docs/SourcesApi.md#sources_user_connections_all_list) | **GET** /sources/user_connections/all/ |
+*SourcesApi* | [**sources_user_connections_all_partial_update**](docs/SourcesApi.md#sources_user_connections_all_partial_update) | **PATCH** /sources/user_connections/all/{id}/ |
+*SourcesApi* | [**sources_user_connections_all_retrieve**](docs/SourcesApi.md#sources_user_connections_all_retrieve) | **GET** /sources/user_connections/all/{id}/ |
+*SourcesApi* | [**sources_user_connections_all_update**](docs/SourcesApi.md#sources_user_connections_all_update) | **PUT** /sources/user_connections/all/{id}/ |
+*SourcesApi* | [**sources_user_connections_all_used_by_list**](docs/SourcesApi.md#sources_user_connections_all_used_by_list) | **GET** /sources/user_connections/all/{id}/used_by/ |
+*SourcesApi* | [**sources_user_connections_kerberos_create**](docs/SourcesApi.md#sources_user_connections_kerberos_create) | **POST** /sources/user_connections/kerberos/ |
+*SourcesApi* | [**sources_user_connections_kerberos_destroy**](docs/SourcesApi.md#sources_user_connections_kerberos_destroy) | **DELETE** /sources/user_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_user_connections_kerberos_list**](docs/SourcesApi.md#sources_user_connections_kerberos_list) | **GET** /sources/user_connections/kerberos/ |
+*SourcesApi* | [**sources_user_connections_kerberos_partial_update**](docs/SourcesApi.md#sources_user_connections_kerberos_partial_update) | **PATCH** /sources/user_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_user_connections_kerberos_retrieve**](docs/SourcesApi.md#sources_user_connections_kerberos_retrieve) | **GET** /sources/user_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_user_connections_kerberos_update**](docs/SourcesApi.md#sources_user_connections_kerberos_update) | **PUT** /sources/user_connections/kerberos/{id}/ |
+*SourcesApi* | [**sources_user_connections_kerberos_used_by_list**](docs/SourcesApi.md#sources_user_connections_kerberos_used_by_list) | **GET** /sources/user_connections/kerberos/{id}/used_by/ |
+*SourcesApi* | [**sources_user_connections_ldap_create**](docs/SourcesApi.md#sources_user_connections_ldap_create) | **POST** /sources/user_connections/ldap/ |
+*SourcesApi* | [**sources_user_connections_ldap_destroy**](docs/SourcesApi.md#sources_user_connections_ldap_destroy) | **DELETE** /sources/user_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_user_connections_ldap_list**](docs/SourcesApi.md#sources_user_connections_ldap_list) | **GET** /sources/user_connections/ldap/ |
+*SourcesApi* | [**sources_user_connections_ldap_partial_update**](docs/SourcesApi.md#sources_user_connections_ldap_partial_update) | **PATCH** /sources/user_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_user_connections_ldap_retrieve**](docs/SourcesApi.md#sources_user_connections_ldap_retrieve) | **GET** /sources/user_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_user_connections_ldap_update**](docs/SourcesApi.md#sources_user_connections_ldap_update) | **PUT** /sources/user_connections/ldap/{id}/ |
+*SourcesApi* | [**sources_user_connections_ldap_used_by_list**](docs/SourcesApi.md#sources_user_connections_ldap_used_by_list) | **GET** /sources/user_connections/ldap/{id}/used_by/ |
+*SourcesApi* | [**sources_user_connections_oauth_create**](docs/SourcesApi.md#sources_user_connections_oauth_create) | **POST** /sources/user_connections/oauth/ |
+*SourcesApi* | [**sources_user_connections_oauth_destroy**](docs/SourcesApi.md#sources_user_connections_oauth_destroy) | **DELETE** /sources/user_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_user_connections_oauth_list**](docs/SourcesApi.md#sources_user_connections_oauth_list) | **GET** /sources/user_connections/oauth/ |
+*SourcesApi* | [**sources_user_connections_oauth_partial_update**](docs/SourcesApi.md#sources_user_connections_oauth_partial_update) | **PATCH** /sources/user_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_user_connections_oauth_retrieve**](docs/SourcesApi.md#sources_user_connections_oauth_retrieve) | **GET** /sources/user_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_user_connections_oauth_update**](docs/SourcesApi.md#sources_user_connections_oauth_update) | **PUT** /sources/user_connections/oauth/{id}/ |
+*SourcesApi* | [**sources_user_connections_oauth_used_by_list**](docs/SourcesApi.md#sources_user_connections_oauth_used_by_list) | **GET** /sources/user_connections/oauth/{id}/used_by/ |
+*SourcesApi* | [**sources_user_connections_plex_create**](docs/SourcesApi.md#sources_user_connections_plex_create) | **POST** /sources/user_connections/plex/ |
+*SourcesApi* | [**sources_user_connections_plex_destroy**](docs/SourcesApi.md#sources_user_connections_plex_destroy) | **DELETE** /sources/user_connections/plex/{id}/ |
+*SourcesApi* | [**sources_user_connections_plex_list**](docs/SourcesApi.md#sources_user_connections_plex_list) | **GET** /sources/user_connections/plex/ |
+*SourcesApi* | [**sources_user_connections_plex_partial_update**](docs/SourcesApi.md#sources_user_connections_plex_partial_update) | **PATCH** /sources/user_connections/plex/{id}/ |
+*SourcesApi* | [**sources_user_connections_plex_retrieve**](docs/SourcesApi.md#sources_user_connections_plex_retrieve) | **GET** /sources/user_connections/plex/{id}/ |
+*SourcesApi* | [**sources_user_connections_plex_update**](docs/SourcesApi.md#sources_user_connections_plex_update) | **PUT** /sources/user_connections/plex/{id}/ |
+*SourcesApi* | [**sources_user_connections_plex_used_by_list**](docs/SourcesApi.md#sources_user_connections_plex_used_by_list) | **GET** /sources/user_connections/plex/{id}/used_by/ |
+*SourcesApi* | [**sources_user_connections_saml_create**](docs/SourcesApi.md#sources_user_connections_saml_create) | **POST** /sources/user_connections/saml/ |
+*SourcesApi* | [**sources_user_connections_saml_destroy**](docs/SourcesApi.md#sources_user_connections_saml_destroy) | **DELETE** /sources/user_connections/saml/{id}/ |
+*SourcesApi* | [**sources_user_connections_saml_list**](docs/SourcesApi.md#sources_user_connections_saml_list) | **GET** /sources/user_connections/saml/ |
+*SourcesApi* | [**sources_user_connections_saml_partial_update**](docs/SourcesApi.md#sources_user_connections_saml_partial_update) | **PATCH** /sources/user_connections/saml/{id}/ |
+*SourcesApi* | [**sources_user_connections_saml_retrieve**](docs/SourcesApi.md#sources_user_connections_saml_retrieve) | **GET** /sources/user_connections/saml/{id}/ |
+*SourcesApi* | [**sources_user_connections_saml_update**](docs/SourcesApi.md#sources_user_connections_saml_update) | **PUT** /sources/user_connections/saml/{id}/ |
+*SourcesApi* | [**sources_user_connections_saml_used_by_list**](docs/SourcesApi.md#sources_user_connections_saml_used_by_list) | **GET** /sources/user_connections/saml/{id}/used_by/ |
+*SourcesApi* | [**sources_user_connections_telegram_create**](docs/SourcesApi.md#sources_user_connections_telegram_create) | **POST** /sources/user_connections/telegram/ |
+*SourcesApi* | [**sources_user_connections_telegram_destroy**](docs/SourcesApi.md#sources_user_connections_telegram_destroy) | **DELETE** /sources/user_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_user_connections_telegram_list**](docs/SourcesApi.md#sources_user_connections_telegram_list) | **GET** /sources/user_connections/telegram/ |
+*SourcesApi* | [**sources_user_connections_telegram_partial_update**](docs/SourcesApi.md#sources_user_connections_telegram_partial_update) | **PATCH** /sources/user_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_user_connections_telegram_retrieve**](docs/SourcesApi.md#sources_user_connections_telegram_retrieve) | **GET** /sources/user_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_user_connections_telegram_update**](docs/SourcesApi.md#sources_user_connections_telegram_update) | **PUT** /sources/user_connections/telegram/{id}/ |
+*SourcesApi* | [**sources_user_connections_telegram_used_by_list**](docs/SourcesApi.md#sources_user_connections_telegram_used_by_list) | **GET** /sources/user_connections/telegram/{id}/used_by/ |
+*SsfApi* | [**ssf_streams_destroy**](docs/SsfApi.md#ssf_streams_destroy) | **DELETE** /ssf/streams/{uuid}/ |
+*SsfApi* | [**ssf_streams_list**](docs/SsfApi.md#ssf_streams_list) | **GET** /ssf/streams/ |
+*SsfApi* | [**ssf_streams_retrieve**](docs/SsfApi.md#ssf_streams_retrieve) | **GET** /ssf/streams/{uuid}/ |
+*StagesApi* | [**stages_account_lockdown_create**](docs/StagesApi.md#stages_account_lockdown_create) | **POST** /stages/account_lockdown/ |
+*StagesApi* | [**stages_account_lockdown_destroy**](docs/StagesApi.md#stages_account_lockdown_destroy) | **DELETE** /stages/account_lockdown/{stage_uuid}/ |
+*StagesApi* | [**stages_account_lockdown_list**](docs/StagesApi.md#stages_account_lockdown_list) | **GET** /stages/account_lockdown/ |
+*StagesApi* | [**stages_account_lockdown_partial_update**](docs/StagesApi.md#stages_account_lockdown_partial_update) | **PATCH** /stages/account_lockdown/{stage_uuid}/ |
+*StagesApi* | [**stages_account_lockdown_retrieve**](docs/StagesApi.md#stages_account_lockdown_retrieve) | **GET** /stages/account_lockdown/{stage_uuid}/ |
+*StagesApi* | [**stages_account_lockdown_update**](docs/StagesApi.md#stages_account_lockdown_update) | **PUT** /stages/account_lockdown/{stage_uuid}/ |
+*StagesApi* | [**stages_account_lockdown_used_by_list**](docs/StagesApi.md#stages_account_lockdown_used_by_list) | **GET** /stages/account_lockdown/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_all_destroy**](docs/StagesApi.md#stages_all_destroy) | **DELETE** /stages/all/{stage_uuid}/ |
+*StagesApi* | [**stages_all_list**](docs/StagesApi.md#stages_all_list) | **GET** /stages/all/ |
+*StagesApi* | [**stages_all_retrieve**](docs/StagesApi.md#stages_all_retrieve) | **GET** /stages/all/{stage_uuid}/ |
+*StagesApi* | [**stages_all_types_list**](docs/StagesApi.md#stages_all_types_list) | **GET** /stages/all/types/ |
+*StagesApi* | [**stages_all_used_by_list**](docs/StagesApi.md#stages_all_used_by_list) | **GET** /stages/all/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_all_user_settings_list**](docs/StagesApi.md#stages_all_user_settings_list) | **GET** /stages/all/user_settings/ |
+*StagesApi* | [**stages_authenticator_duo_create**](docs/StagesApi.md#stages_authenticator_duo_create) | **POST** /stages/authenticator/duo/ |
+*StagesApi* | [**stages_authenticator_duo_destroy**](docs/StagesApi.md#stages_authenticator_duo_destroy) | **DELETE** /stages/authenticator/duo/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_duo_enrollment_status_create**](docs/StagesApi.md#stages_authenticator_duo_enrollment_status_create) | **POST** /stages/authenticator/duo/{stage_uuid}/enrollment_status/ |
+*StagesApi* | [**stages_authenticator_duo_import_device_manual_create**](docs/StagesApi.md#stages_authenticator_duo_import_device_manual_create) | **POST** /stages/authenticator/duo/{stage_uuid}/import_device_manual/ |
+*StagesApi* | [**stages_authenticator_duo_import_devices_automatic_create**](docs/StagesApi.md#stages_authenticator_duo_import_devices_automatic_create) | **POST** /stages/authenticator/duo/{stage_uuid}/import_devices_automatic/ |
+*StagesApi* | [**stages_authenticator_duo_list**](docs/StagesApi.md#stages_authenticator_duo_list) | **GET** /stages/authenticator/duo/ |
+*StagesApi* | [**stages_authenticator_duo_partial_update**](docs/StagesApi.md#stages_authenticator_duo_partial_update) | **PATCH** /stages/authenticator/duo/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_duo_retrieve**](docs/StagesApi.md#stages_authenticator_duo_retrieve) | **GET** /stages/authenticator/duo/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_duo_update**](docs/StagesApi.md#stages_authenticator_duo_update) | **PUT** /stages/authenticator/duo/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_duo_used_by_list**](docs/StagesApi.md#stages_authenticator_duo_used_by_list) | **GET** /stages/authenticator/duo/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_email_create**](docs/StagesApi.md#stages_authenticator_email_create) | **POST** /stages/authenticator/email/ |
+*StagesApi* | [**stages_authenticator_email_destroy**](docs/StagesApi.md#stages_authenticator_email_destroy) | **DELETE** /stages/authenticator/email/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_email_list**](docs/StagesApi.md#stages_authenticator_email_list) | **GET** /stages/authenticator/email/ |
+*StagesApi* | [**stages_authenticator_email_partial_update**](docs/StagesApi.md#stages_authenticator_email_partial_update) | **PATCH** /stages/authenticator/email/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_email_retrieve**](docs/StagesApi.md#stages_authenticator_email_retrieve) | **GET** /stages/authenticator/email/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_email_update**](docs/StagesApi.md#stages_authenticator_email_update) | **PUT** /stages/authenticator/email/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_email_used_by_list**](docs/StagesApi.md#stages_authenticator_email_used_by_list) | **GET** /stages/authenticator/email/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_create**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_create) | **POST** /stages/authenticator/endpoint_gdtc/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_destroy**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_destroy) | **DELETE** /stages/authenticator/endpoint_gdtc/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_list**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_list) | **GET** /stages/authenticator/endpoint_gdtc/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_partial_update**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_partial_update) | **PATCH** /stages/authenticator/endpoint_gdtc/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_retrieve**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_retrieve) | **GET** /stages/authenticator/endpoint_gdtc/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_update**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_update) | **PUT** /stages/authenticator/endpoint_gdtc/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_endpoint_gdtc_used_by_list**](docs/StagesApi.md#stages_authenticator_endpoint_gdtc_used_by_list) | **GET** /stages/authenticator/endpoint_gdtc/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_sms_create**](docs/StagesApi.md#stages_authenticator_sms_create) | **POST** /stages/authenticator/sms/ |
+*StagesApi* | [**stages_authenticator_sms_destroy**](docs/StagesApi.md#stages_authenticator_sms_destroy) | **DELETE** /stages/authenticator/sms/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_sms_list**](docs/StagesApi.md#stages_authenticator_sms_list) | **GET** /stages/authenticator/sms/ |
+*StagesApi* | [**stages_authenticator_sms_partial_update**](docs/StagesApi.md#stages_authenticator_sms_partial_update) | **PATCH** /stages/authenticator/sms/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_sms_retrieve**](docs/StagesApi.md#stages_authenticator_sms_retrieve) | **GET** /stages/authenticator/sms/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_sms_update**](docs/StagesApi.md#stages_authenticator_sms_update) | **PUT** /stages/authenticator/sms/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_sms_used_by_list**](docs/StagesApi.md#stages_authenticator_sms_used_by_list) | **GET** /stages/authenticator/sms/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_static_create**](docs/StagesApi.md#stages_authenticator_static_create) | **POST** /stages/authenticator/static/ |
+*StagesApi* | [**stages_authenticator_static_destroy**](docs/StagesApi.md#stages_authenticator_static_destroy) | **DELETE** /stages/authenticator/static/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_static_list**](docs/StagesApi.md#stages_authenticator_static_list) | **GET** /stages/authenticator/static/ |
+*StagesApi* | [**stages_authenticator_static_partial_update**](docs/StagesApi.md#stages_authenticator_static_partial_update) | **PATCH** /stages/authenticator/static/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_static_retrieve**](docs/StagesApi.md#stages_authenticator_static_retrieve) | **GET** /stages/authenticator/static/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_static_update**](docs/StagesApi.md#stages_authenticator_static_update) | **PUT** /stages/authenticator/static/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_static_used_by_list**](docs/StagesApi.md#stages_authenticator_static_used_by_list) | **GET** /stages/authenticator/static/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_totp_create**](docs/StagesApi.md#stages_authenticator_totp_create) | **POST** /stages/authenticator/totp/ |
+*StagesApi* | [**stages_authenticator_totp_destroy**](docs/StagesApi.md#stages_authenticator_totp_destroy) | **DELETE** /stages/authenticator/totp/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_totp_list**](docs/StagesApi.md#stages_authenticator_totp_list) | **GET** /stages/authenticator/totp/ |
+*StagesApi* | [**stages_authenticator_totp_partial_update**](docs/StagesApi.md#stages_authenticator_totp_partial_update) | **PATCH** /stages/authenticator/totp/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_totp_retrieve**](docs/StagesApi.md#stages_authenticator_totp_retrieve) | **GET** /stages/authenticator/totp/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_totp_update**](docs/StagesApi.md#stages_authenticator_totp_update) | **PUT** /stages/authenticator/totp/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_totp_used_by_list**](docs/StagesApi.md#stages_authenticator_totp_used_by_list) | **GET** /stages/authenticator/totp/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_validate_create**](docs/StagesApi.md#stages_authenticator_validate_create) | **POST** /stages/authenticator/validate/ |
+*StagesApi* | [**stages_authenticator_validate_destroy**](docs/StagesApi.md#stages_authenticator_validate_destroy) | **DELETE** /stages/authenticator/validate/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_validate_list**](docs/StagesApi.md#stages_authenticator_validate_list) | **GET** /stages/authenticator/validate/ |
+*StagesApi* | [**stages_authenticator_validate_partial_update**](docs/StagesApi.md#stages_authenticator_validate_partial_update) | **PATCH** /stages/authenticator/validate/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_validate_retrieve**](docs/StagesApi.md#stages_authenticator_validate_retrieve) | **GET** /stages/authenticator/validate/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_validate_update**](docs/StagesApi.md#stages_authenticator_validate_update) | **PUT** /stages/authenticator/validate/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_validate_used_by_list**](docs/StagesApi.md#stages_authenticator_validate_used_by_list) | **GET** /stages/authenticator/validate/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_authenticator_webauthn_create**](docs/StagesApi.md#stages_authenticator_webauthn_create) | **POST** /stages/authenticator/webauthn/ |
+*StagesApi* | [**stages_authenticator_webauthn_destroy**](docs/StagesApi.md#stages_authenticator_webauthn_destroy) | **DELETE** /stages/authenticator/webauthn/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_webauthn_device_types_list**](docs/StagesApi.md#stages_authenticator_webauthn_device_types_list) | **GET** /stages/authenticator/webauthn_device_types/ |
+*StagesApi* | [**stages_authenticator_webauthn_device_types_retrieve**](docs/StagesApi.md#stages_authenticator_webauthn_device_types_retrieve) | **GET** /stages/authenticator/webauthn_device_types/{aaguid}/ |
+*StagesApi* | [**stages_authenticator_webauthn_list**](docs/StagesApi.md#stages_authenticator_webauthn_list) | **GET** /stages/authenticator/webauthn/ |
+*StagesApi* | [**stages_authenticator_webauthn_partial_update**](docs/StagesApi.md#stages_authenticator_webauthn_partial_update) | **PATCH** /stages/authenticator/webauthn/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_webauthn_retrieve**](docs/StagesApi.md#stages_authenticator_webauthn_retrieve) | **GET** /stages/authenticator/webauthn/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_webauthn_update**](docs/StagesApi.md#stages_authenticator_webauthn_update) | **PUT** /stages/authenticator/webauthn/{stage_uuid}/ |
+*StagesApi* | [**stages_authenticator_webauthn_used_by_list**](docs/StagesApi.md#stages_authenticator_webauthn_used_by_list) | **GET** /stages/authenticator/webauthn/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_captcha_create**](docs/StagesApi.md#stages_captcha_create) | **POST** /stages/captcha/ |
+*StagesApi* | [**stages_captcha_destroy**](docs/StagesApi.md#stages_captcha_destroy) | **DELETE** /stages/captcha/{stage_uuid}/ |
+*StagesApi* | [**stages_captcha_list**](docs/StagesApi.md#stages_captcha_list) | **GET** /stages/captcha/ |
+*StagesApi* | [**stages_captcha_partial_update**](docs/StagesApi.md#stages_captcha_partial_update) | **PATCH** /stages/captcha/{stage_uuid}/ |
+*StagesApi* | [**stages_captcha_retrieve**](docs/StagesApi.md#stages_captcha_retrieve) | **GET** /stages/captcha/{stage_uuid}/ |
+*StagesApi* | [**stages_captcha_update**](docs/StagesApi.md#stages_captcha_update) | **PUT** /stages/captcha/{stage_uuid}/ |
+*StagesApi* | [**stages_captcha_used_by_list**](docs/StagesApi.md#stages_captcha_used_by_list) | **GET** /stages/captcha/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_consent_create**](docs/StagesApi.md#stages_consent_create) | **POST** /stages/consent/ |
+*StagesApi* | [**stages_consent_destroy**](docs/StagesApi.md#stages_consent_destroy) | **DELETE** /stages/consent/{stage_uuid}/ |
+*StagesApi* | [**stages_consent_list**](docs/StagesApi.md#stages_consent_list) | **GET** /stages/consent/ |
+*StagesApi* | [**stages_consent_partial_update**](docs/StagesApi.md#stages_consent_partial_update) | **PATCH** /stages/consent/{stage_uuid}/ |
+*StagesApi* | [**stages_consent_retrieve**](docs/StagesApi.md#stages_consent_retrieve) | **GET** /stages/consent/{stage_uuid}/ |
+*StagesApi* | [**stages_consent_update**](docs/StagesApi.md#stages_consent_update) | **PUT** /stages/consent/{stage_uuid}/ |
+*StagesApi* | [**stages_consent_used_by_list**](docs/StagesApi.md#stages_consent_used_by_list) | **GET** /stages/consent/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_deny_create**](docs/StagesApi.md#stages_deny_create) | **POST** /stages/deny/ |
+*StagesApi* | [**stages_deny_destroy**](docs/StagesApi.md#stages_deny_destroy) | **DELETE** /stages/deny/{stage_uuid}/ |
+*StagesApi* | [**stages_deny_list**](docs/StagesApi.md#stages_deny_list) | **GET** /stages/deny/ |
+*StagesApi* | [**stages_deny_partial_update**](docs/StagesApi.md#stages_deny_partial_update) | **PATCH** /stages/deny/{stage_uuid}/ |
+*StagesApi* | [**stages_deny_retrieve**](docs/StagesApi.md#stages_deny_retrieve) | **GET** /stages/deny/{stage_uuid}/ |
+*StagesApi* | [**stages_deny_update**](docs/StagesApi.md#stages_deny_update) | **PUT** /stages/deny/{stage_uuid}/ |
+*StagesApi* | [**stages_deny_used_by_list**](docs/StagesApi.md#stages_deny_used_by_list) | **GET** /stages/deny/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_dummy_create**](docs/StagesApi.md#stages_dummy_create) | **POST** /stages/dummy/ |
+*StagesApi* | [**stages_dummy_destroy**](docs/StagesApi.md#stages_dummy_destroy) | **DELETE** /stages/dummy/{stage_uuid}/ |
+*StagesApi* | [**stages_dummy_list**](docs/StagesApi.md#stages_dummy_list) | **GET** /stages/dummy/ |
+*StagesApi* | [**stages_dummy_partial_update**](docs/StagesApi.md#stages_dummy_partial_update) | **PATCH** /stages/dummy/{stage_uuid}/ |
+*StagesApi* | [**stages_dummy_retrieve**](docs/StagesApi.md#stages_dummy_retrieve) | **GET** /stages/dummy/{stage_uuid}/ |
+*StagesApi* | [**stages_dummy_update**](docs/StagesApi.md#stages_dummy_update) | **PUT** /stages/dummy/{stage_uuid}/ |
+*StagesApi* | [**stages_dummy_used_by_list**](docs/StagesApi.md#stages_dummy_used_by_list) | **GET** /stages/dummy/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_email_create**](docs/StagesApi.md#stages_email_create) | **POST** /stages/email/ |
+*StagesApi* | [**stages_email_destroy**](docs/StagesApi.md#stages_email_destroy) | **DELETE** /stages/email/{stage_uuid}/ |
+*StagesApi* | [**stages_email_list**](docs/StagesApi.md#stages_email_list) | **GET** /stages/email/ |
+*StagesApi* | [**stages_email_partial_update**](docs/StagesApi.md#stages_email_partial_update) | **PATCH** /stages/email/{stage_uuid}/ |
+*StagesApi* | [**stages_email_retrieve**](docs/StagesApi.md#stages_email_retrieve) | **GET** /stages/email/{stage_uuid}/ |
+*StagesApi* | [**stages_email_templates_list**](docs/StagesApi.md#stages_email_templates_list) | **GET** /stages/email/templates/ |
+*StagesApi* | [**stages_email_update**](docs/StagesApi.md#stages_email_update) | **PUT** /stages/email/{stage_uuid}/ |
+*StagesApi* | [**stages_email_used_by_list**](docs/StagesApi.md#stages_email_used_by_list) | **GET** /stages/email/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_endpoints_create**](docs/StagesApi.md#stages_endpoints_create) | **POST** /stages/endpoints/ |
+*StagesApi* | [**stages_endpoints_destroy**](docs/StagesApi.md#stages_endpoints_destroy) | **DELETE** /stages/endpoints/{stage_uuid}/ |
+*StagesApi* | [**stages_endpoints_list**](docs/StagesApi.md#stages_endpoints_list) | **GET** /stages/endpoints/ |
+*StagesApi* | [**stages_endpoints_partial_update**](docs/StagesApi.md#stages_endpoints_partial_update) | **PATCH** /stages/endpoints/{stage_uuid}/ |
+*StagesApi* | [**stages_endpoints_retrieve**](docs/StagesApi.md#stages_endpoints_retrieve) | **GET** /stages/endpoints/{stage_uuid}/ |
+*StagesApi* | [**stages_endpoints_update**](docs/StagesApi.md#stages_endpoints_update) | **PUT** /stages/endpoints/{stage_uuid}/ |
+*StagesApi* | [**stages_endpoints_used_by_list**](docs/StagesApi.md#stages_endpoints_used_by_list) | **GET** /stages/endpoints/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_identification_create**](docs/StagesApi.md#stages_identification_create) | **POST** /stages/identification/ |
+*StagesApi* | [**stages_identification_destroy**](docs/StagesApi.md#stages_identification_destroy) | **DELETE** /stages/identification/{stage_uuid}/ |
+*StagesApi* | [**stages_identification_list**](docs/StagesApi.md#stages_identification_list) | **GET** /stages/identification/ |
+*StagesApi* | [**stages_identification_partial_update**](docs/StagesApi.md#stages_identification_partial_update) | **PATCH** /stages/identification/{stage_uuid}/ |
+*StagesApi* | [**stages_identification_retrieve**](docs/StagesApi.md#stages_identification_retrieve) | **GET** /stages/identification/{stage_uuid}/ |
+*StagesApi* | [**stages_identification_update**](docs/StagesApi.md#stages_identification_update) | **PUT** /stages/identification/{stage_uuid}/ |
+*StagesApi* | [**stages_identification_used_by_list**](docs/StagesApi.md#stages_identification_used_by_list) | **GET** /stages/identification/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_invitation_invitations_create**](docs/StagesApi.md#stages_invitation_invitations_create) | **POST** /stages/invitation/invitations/ |
+*StagesApi* | [**stages_invitation_invitations_destroy**](docs/StagesApi.md#stages_invitation_invitations_destroy) | **DELETE** /stages/invitation/invitations/{invite_uuid}/ |
+*StagesApi* | [**stages_invitation_invitations_list**](docs/StagesApi.md#stages_invitation_invitations_list) | **GET** /stages/invitation/invitations/ |
+*StagesApi* | [**stages_invitation_invitations_partial_update**](docs/StagesApi.md#stages_invitation_invitations_partial_update) | **PATCH** /stages/invitation/invitations/{invite_uuid}/ |
+*StagesApi* | [**stages_invitation_invitations_retrieve**](docs/StagesApi.md#stages_invitation_invitations_retrieve) | **GET** /stages/invitation/invitations/{invite_uuid}/ |
+*StagesApi* | [**stages_invitation_invitations_send_email_create**](docs/StagesApi.md#stages_invitation_invitations_send_email_create) | **POST** /stages/invitation/invitations/{invite_uuid}/send_email/ |
+*StagesApi* | [**stages_invitation_invitations_update**](docs/StagesApi.md#stages_invitation_invitations_update) | **PUT** /stages/invitation/invitations/{invite_uuid}/ |
+*StagesApi* | [**stages_invitation_invitations_used_by_list**](docs/StagesApi.md#stages_invitation_invitations_used_by_list) | **GET** /stages/invitation/invitations/{invite_uuid}/used_by/ |
+*StagesApi* | [**stages_invitation_stages_create**](docs/StagesApi.md#stages_invitation_stages_create) | **POST** /stages/invitation/stages/ |
+*StagesApi* | [**stages_invitation_stages_destroy**](docs/StagesApi.md#stages_invitation_stages_destroy) | **DELETE** /stages/invitation/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_invitation_stages_list**](docs/StagesApi.md#stages_invitation_stages_list) | **GET** /stages/invitation/stages/ |
+*StagesApi* | [**stages_invitation_stages_partial_update**](docs/StagesApi.md#stages_invitation_stages_partial_update) | **PATCH** /stages/invitation/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_invitation_stages_retrieve**](docs/StagesApi.md#stages_invitation_stages_retrieve) | **GET** /stages/invitation/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_invitation_stages_update**](docs/StagesApi.md#stages_invitation_stages_update) | **PUT** /stages/invitation/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_invitation_stages_used_by_list**](docs/StagesApi.md#stages_invitation_stages_used_by_list) | **GET** /stages/invitation/stages/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_mtls_create**](docs/StagesApi.md#stages_mtls_create) | **POST** /stages/mtls/ |
+*StagesApi* | [**stages_mtls_destroy**](docs/StagesApi.md#stages_mtls_destroy) | **DELETE** /stages/mtls/{stage_uuid}/ |
+*StagesApi* | [**stages_mtls_list**](docs/StagesApi.md#stages_mtls_list) | **GET** /stages/mtls/ |
+*StagesApi* | [**stages_mtls_partial_update**](docs/StagesApi.md#stages_mtls_partial_update) | **PATCH** /stages/mtls/{stage_uuid}/ |
+*StagesApi* | [**stages_mtls_retrieve**](docs/StagesApi.md#stages_mtls_retrieve) | **GET** /stages/mtls/{stage_uuid}/ |
+*StagesApi* | [**stages_mtls_update**](docs/StagesApi.md#stages_mtls_update) | **PUT** /stages/mtls/{stage_uuid}/ |
+*StagesApi* | [**stages_mtls_used_by_list**](docs/StagesApi.md#stages_mtls_used_by_list) | **GET** /stages/mtls/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_password_create**](docs/StagesApi.md#stages_password_create) | **POST** /stages/password/ |
+*StagesApi* | [**stages_password_destroy**](docs/StagesApi.md#stages_password_destroy) | **DELETE** /stages/password/{stage_uuid}/ |
+*StagesApi* | [**stages_password_list**](docs/StagesApi.md#stages_password_list) | **GET** /stages/password/ |
+*StagesApi* | [**stages_password_partial_update**](docs/StagesApi.md#stages_password_partial_update) | **PATCH** /stages/password/{stage_uuid}/ |
+*StagesApi* | [**stages_password_retrieve**](docs/StagesApi.md#stages_password_retrieve) | **GET** /stages/password/{stage_uuid}/ |
+*StagesApi* | [**stages_password_update**](docs/StagesApi.md#stages_password_update) | **PUT** /stages/password/{stage_uuid}/ |
+*StagesApi* | [**stages_password_used_by_list**](docs/StagesApi.md#stages_password_used_by_list) | **GET** /stages/password/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_prompt_prompts_create**](docs/StagesApi.md#stages_prompt_prompts_create) | **POST** /stages/prompt/prompts/ |
+*StagesApi* | [**stages_prompt_prompts_destroy**](docs/StagesApi.md#stages_prompt_prompts_destroy) | **DELETE** /stages/prompt/prompts/{prompt_uuid}/ |
+*StagesApi* | [**stages_prompt_prompts_list**](docs/StagesApi.md#stages_prompt_prompts_list) | **GET** /stages/prompt/prompts/ |
+*StagesApi* | [**stages_prompt_prompts_partial_update**](docs/StagesApi.md#stages_prompt_prompts_partial_update) | **PATCH** /stages/prompt/prompts/{prompt_uuid}/ |
+*StagesApi* | [**stages_prompt_prompts_preview_create**](docs/StagesApi.md#stages_prompt_prompts_preview_create) | **POST** /stages/prompt/prompts/preview/ |
+*StagesApi* | [**stages_prompt_prompts_retrieve**](docs/StagesApi.md#stages_prompt_prompts_retrieve) | **GET** /stages/prompt/prompts/{prompt_uuid}/ |
+*StagesApi* | [**stages_prompt_prompts_update**](docs/StagesApi.md#stages_prompt_prompts_update) | **PUT** /stages/prompt/prompts/{prompt_uuid}/ |
+*StagesApi* | [**stages_prompt_prompts_used_by_list**](docs/StagesApi.md#stages_prompt_prompts_used_by_list) | **GET** /stages/prompt/prompts/{prompt_uuid}/used_by/ |
+*StagesApi* | [**stages_prompt_stages_create**](docs/StagesApi.md#stages_prompt_stages_create) | **POST** /stages/prompt/stages/ |
+*StagesApi* | [**stages_prompt_stages_destroy**](docs/StagesApi.md#stages_prompt_stages_destroy) | **DELETE** /stages/prompt/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_prompt_stages_list**](docs/StagesApi.md#stages_prompt_stages_list) | **GET** /stages/prompt/stages/ |
+*StagesApi* | [**stages_prompt_stages_partial_update**](docs/StagesApi.md#stages_prompt_stages_partial_update) | **PATCH** /stages/prompt/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_prompt_stages_retrieve**](docs/StagesApi.md#stages_prompt_stages_retrieve) | **GET** /stages/prompt/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_prompt_stages_update**](docs/StagesApi.md#stages_prompt_stages_update) | **PUT** /stages/prompt/stages/{stage_uuid}/ |
+*StagesApi* | [**stages_prompt_stages_used_by_list**](docs/StagesApi.md#stages_prompt_stages_used_by_list) | **GET** /stages/prompt/stages/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_redirect_create**](docs/StagesApi.md#stages_redirect_create) | **POST** /stages/redirect/ |
+*StagesApi* | [**stages_redirect_destroy**](docs/StagesApi.md#stages_redirect_destroy) | **DELETE** /stages/redirect/{stage_uuid}/ |
+*StagesApi* | [**stages_redirect_list**](docs/StagesApi.md#stages_redirect_list) | **GET** /stages/redirect/ |
+*StagesApi* | [**stages_redirect_partial_update**](docs/StagesApi.md#stages_redirect_partial_update) | **PATCH** /stages/redirect/{stage_uuid}/ |
+*StagesApi* | [**stages_redirect_retrieve**](docs/StagesApi.md#stages_redirect_retrieve) | **GET** /stages/redirect/{stage_uuid}/ |
+*StagesApi* | [**stages_redirect_update**](docs/StagesApi.md#stages_redirect_update) | **PUT** /stages/redirect/{stage_uuid}/ |
+*StagesApi* | [**stages_redirect_used_by_list**](docs/StagesApi.md#stages_redirect_used_by_list) | **GET** /stages/redirect/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_source_create**](docs/StagesApi.md#stages_source_create) | **POST** /stages/source/ |
+*StagesApi* | [**stages_source_destroy**](docs/StagesApi.md#stages_source_destroy) | **DELETE** /stages/source/{stage_uuid}/ |
+*StagesApi* | [**stages_source_list**](docs/StagesApi.md#stages_source_list) | **GET** /stages/source/ |
+*StagesApi* | [**stages_source_partial_update**](docs/StagesApi.md#stages_source_partial_update) | **PATCH** /stages/source/{stage_uuid}/ |
+*StagesApi* | [**stages_source_retrieve**](docs/StagesApi.md#stages_source_retrieve) | **GET** /stages/source/{stage_uuid}/ |
+*StagesApi* | [**stages_source_update**](docs/StagesApi.md#stages_source_update) | **PUT** /stages/source/{stage_uuid}/ |
+*StagesApi* | [**stages_source_used_by_list**](docs/StagesApi.md#stages_source_used_by_list) | **GET** /stages/source/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_user_delete_create**](docs/StagesApi.md#stages_user_delete_create) | **POST** /stages/user_delete/ |
+*StagesApi* | [**stages_user_delete_destroy**](docs/StagesApi.md#stages_user_delete_destroy) | **DELETE** /stages/user_delete/{stage_uuid}/ |
+*StagesApi* | [**stages_user_delete_list**](docs/StagesApi.md#stages_user_delete_list) | **GET** /stages/user_delete/ |
+*StagesApi* | [**stages_user_delete_partial_update**](docs/StagesApi.md#stages_user_delete_partial_update) | **PATCH** /stages/user_delete/{stage_uuid}/ |
+*StagesApi* | [**stages_user_delete_retrieve**](docs/StagesApi.md#stages_user_delete_retrieve) | **GET** /stages/user_delete/{stage_uuid}/ |
+*StagesApi* | [**stages_user_delete_update**](docs/StagesApi.md#stages_user_delete_update) | **PUT** /stages/user_delete/{stage_uuid}/ |
+*StagesApi* | [**stages_user_delete_used_by_list**](docs/StagesApi.md#stages_user_delete_used_by_list) | **GET** /stages/user_delete/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_user_login_create**](docs/StagesApi.md#stages_user_login_create) | **POST** /stages/user_login/ |
+*StagesApi* | [**stages_user_login_destroy**](docs/StagesApi.md#stages_user_login_destroy) | **DELETE** /stages/user_login/{stage_uuid}/ |
+*StagesApi* | [**stages_user_login_list**](docs/StagesApi.md#stages_user_login_list) | **GET** /stages/user_login/ |
+*StagesApi* | [**stages_user_login_partial_update**](docs/StagesApi.md#stages_user_login_partial_update) | **PATCH** /stages/user_login/{stage_uuid}/ |
+*StagesApi* | [**stages_user_login_retrieve**](docs/StagesApi.md#stages_user_login_retrieve) | **GET** /stages/user_login/{stage_uuid}/ |
+*StagesApi* | [**stages_user_login_update**](docs/StagesApi.md#stages_user_login_update) | **PUT** /stages/user_login/{stage_uuid}/ |
+*StagesApi* | [**stages_user_login_used_by_list**](docs/StagesApi.md#stages_user_login_used_by_list) | **GET** /stages/user_login/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_user_logout_create**](docs/StagesApi.md#stages_user_logout_create) | **POST** /stages/user_logout/ |
+*StagesApi* | [**stages_user_logout_destroy**](docs/StagesApi.md#stages_user_logout_destroy) | **DELETE** /stages/user_logout/{stage_uuid}/ |
+*StagesApi* | [**stages_user_logout_list**](docs/StagesApi.md#stages_user_logout_list) | **GET** /stages/user_logout/ |
+*StagesApi* | [**stages_user_logout_partial_update**](docs/StagesApi.md#stages_user_logout_partial_update) | **PATCH** /stages/user_logout/{stage_uuid}/ |
+*StagesApi* | [**stages_user_logout_retrieve**](docs/StagesApi.md#stages_user_logout_retrieve) | **GET** /stages/user_logout/{stage_uuid}/ |
+*StagesApi* | [**stages_user_logout_update**](docs/StagesApi.md#stages_user_logout_update) | **PUT** /stages/user_logout/{stage_uuid}/ |
+*StagesApi* | [**stages_user_logout_used_by_list**](docs/StagesApi.md#stages_user_logout_used_by_list) | **GET** /stages/user_logout/{stage_uuid}/used_by/ |
+*StagesApi* | [**stages_user_write_create**](docs/StagesApi.md#stages_user_write_create) | **POST** /stages/user_write/ |
+*StagesApi* | [**stages_user_write_destroy**](docs/StagesApi.md#stages_user_write_destroy) | **DELETE** /stages/user_write/{stage_uuid}/ |
+*StagesApi* | [**stages_user_write_list**](docs/StagesApi.md#stages_user_write_list) | **GET** /stages/user_write/ |
+*StagesApi* | [**stages_user_write_partial_update**](docs/StagesApi.md#stages_user_write_partial_update) | **PATCH** /stages/user_write/{stage_uuid}/ |
+*StagesApi* | [**stages_user_write_retrieve**](docs/StagesApi.md#stages_user_write_retrieve) | **GET** /stages/user_write/{stage_uuid}/ |
+*StagesApi* | [**stages_user_write_update**](docs/StagesApi.md#stages_user_write_update) | **PUT** /stages/user_write/{stage_uuid}/ |
+*StagesApi* | [**stages_user_write_used_by_list**](docs/StagesApi.md#stages_user_write_used_by_list) | **GET** /stages/user_write/{stage_uuid}/used_by/ |
+*TasksApi* | [**tasks_schedules_list**](docs/TasksApi.md#tasks_schedules_list) | **GET** /tasks/schedules/ |
+*TasksApi* | [**tasks_schedules_partial_update**](docs/TasksApi.md#tasks_schedules_partial_update) | **PATCH** /tasks/schedules/{id}/ |
+*TasksApi* | [**tasks_schedules_retrieve**](docs/TasksApi.md#tasks_schedules_retrieve) | **GET** /tasks/schedules/{id}/ |
+*TasksApi* | [**tasks_schedules_send_create**](docs/TasksApi.md#tasks_schedules_send_create) | **POST** /tasks/schedules/{id}/send/ |
+*TasksApi* | [**tasks_schedules_update**](docs/TasksApi.md#tasks_schedules_update) | **PUT** /tasks/schedules/{id}/ |
+*TasksApi* | [**tasks_tasks_list**](docs/TasksApi.md#tasks_tasks_list) | **GET** /tasks/tasks/ |
+*TasksApi* | [**tasks_tasks_retrieve**](docs/TasksApi.md#tasks_tasks_retrieve) | **GET** /tasks/tasks/{message_id}/ |
+*TasksApi* | [**tasks_tasks_retry_create**](docs/TasksApi.md#tasks_tasks_retry_create) | **POST** /tasks/tasks/{message_id}/retry/ |
+*TasksApi* | [**tasks_tasks_status_retrieve**](docs/TasksApi.md#tasks_tasks_status_retrieve) | **GET** /tasks/tasks/status/ |
+*TasksApi* | [**tasks_workers_list**](docs/TasksApi.md#tasks_workers_list) | **GET** /tasks/workers/ |
+*TenantsApi* | [**tenants_domains_create**](docs/TenantsApi.md#tenants_domains_create) | **POST** /tenants/domains/ |
+*TenantsApi* | [**tenants_domains_destroy**](docs/TenantsApi.md#tenants_domains_destroy) | **DELETE** /tenants/domains/{id}/ |
+*TenantsApi* | [**tenants_domains_list**](docs/TenantsApi.md#tenants_domains_list) | **GET** /tenants/domains/ |
+*TenantsApi* | [**tenants_domains_partial_update**](docs/TenantsApi.md#tenants_domains_partial_update) | **PATCH** /tenants/domains/{id}/ |
+*TenantsApi* | [**tenants_domains_retrieve**](docs/TenantsApi.md#tenants_domains_retrieve) | **GET** /tenants/domains/{id}/ |
+*TenantsApi* | [**tenants_domains_update**](docs/TenantsApi.md#tenants_domains_update) | **PUT** /tenants/domains/{id}/ |
+*TenantsApi* | [**tenants_tenants_create**](docs/TenantsApi.md#tenants_tenants_create) | **POST** /tenants/tenants/ |
+*TenantsApi* | [**tenants_tenants_create_admin_group_create**](docs/TenantsApi.md#tenants_tenants_create_admin_group_create) | **POST** /tenants/tenants/{tenant_uuid}/create_admin_group/ |
+*TenantsApi* | [**tenants_tenants_create_recovery_key_create**](docs/TenantsApi.md#tenants_tenants_create_recovery_key_create) | **POST** /tenants/tenants/{tenant_uuid}/create_recovery_key/ |
+*TenantsApi* | [**tenants_tenants_destroy**](docs/TenantsApi.md#tenants_tenants_destroy) | **DELETE** /tenants/tenants/{tenant_uuid}/ |
+*TenantsApi* | [**tenants_tenants_list**](docs/TenantsApi.md#tenants_tenants_list) | **GET** /tenants/tenants/ |
+*TenantsApi* | [**tenants_tenants_partial_update**](docs/TenantsApi.md#tenants_tenants_partial_update) | **PATCH** /tenants/tenants/{tenant_uuid}/ |
+*TenantsApi* | [**tenants_tenants_retrieve**](docs/TenantsApi.md#tenants_tenants_retrieve) | **GET** /tenants/tenants/{tenant_uuid}/ |
+*TenantsApi* | [**tenants_tenants_update**](docs/TenantsApi.md#tenants_tenants_update) | **PUT** /tenants/tenants/{tenant_uuid}/ |
+
+
+## Documentation For Models
+
+ - [AccessDeniedChallenge](docs/AccessDeniedChallenge.md)
+ - [AccountLockdownStage](docs/AccountLockdownStage.md)
+ - [AccountLockdownStageRequest](docs/AccountLockdownStageRequest.md)
+ - [AgentAuthenticationResponse](docs/AgentAuthenticationResponse.md)
+ - [AgentConfig](docs/AgentConfig.md)
+ - [AgentConnector](docs/AgentConnector.md)
+ - [AgentConnectorRequest](docs/AgentConnectorRequest.md)
+ - [AgentPSSODeviceRegistrationRequest](docs/AgentPSSODeviceRegistrationRequest.md)
+ - [AgentPSSODeviceRegistrationResponse](docs/AgentPSSODeviceRegistrationResponse.md)
+ - [AgentPSSOUserRegistrationRequest](docs/AgentPSSOUserRegistrationRequest.md)
+ - [AgentTokenResponse](docs/AgentTokenResponse.md)
+ - [AlgEnum](docs/AlgEnum.md)
+ - [App](docs/App.md)
+ - [AppEnum](docs/AppEnum.md)
+ - [AppleChallengeResponseRequest](docs/AppleChallengeResponseRequest.md)
+ - [AppleIndependentSecureEnclave](docs/AppleIndependentSecureEnclave.md)
+ - [AppleIndependentSecureEnclaveRequest](docs/AppleIndependentSecureEnclaveRequest.md)
+ - [AppleLoginChallenge](docs/AppleLoginChallenge.md)
+ - [Application](docs/Application.md)
+ - [ApplicationEntitlement](docs/ApplicationEntitlement.md)
+ - [ApplicationEntitlementRequest](docs/ApplicationEntitlementRequest.md)
+ - [ApplicationRequest](docs/ApplicationRequest.md)
+ - [AuthTypeEnum](docs/AuthTypeEnum.md)
+ - [AuthenticatedSession](docs/AuthenticatedSession.md)
+ - [AuthenticatedSessionAsn](docs/AuthenticatedSessionAsn.md)
+ - [AuthenticatedSessionGeoIp](docs/AuthenticatedSessionGeoIp.md)
+ - [AuthenticatedSessionUserAgent](docs/AuthenticatedSessionUserAgent.md)
+ - [AuthenticatedSessionUserAgentDevice](docs/AuthenticatedSessionUserAgentDevice.md)
+ - [AuthenticatedSessionUserAgentOs](docs/AuthenticatedSessionUserAgentOs.md)
+ - [AuthenticatedSessionUserAgentUserAgent](docs/AuthenticatedSessionUserAgentUserAgent.md)
+ - [AuthenticationEnum](docs/AuthenticationEnum.md)
+ - [AuthenticatorAttachmentEnum](docs/AuthenticatorAttachmentEnum.md)
+ - [AuthenticatorDuoChallenge](docs/AuthenticatorDuoChallenge.md)
+ - [AuthenticatorDuoChallengeResponseRequest](docs/AuthenticatorDuoChallengeResponseRequest.md)
+ - [AuthenticatorDuoStage](docs/AuthenticatorDuoStage.md)
+ - [AuthenticatorDuoStageDeviceImportResponse](docs/AuthenticatorDuoStageDeviceImportResponse.md)
+ - [AuthenticatorDuoStageManualDeviceImportRequest](docs/AuthenticatorDuoStageManualDeviceImportRequest.md)
+ - [AuthenticatorDuoStageRequest](docs/AuthenticatorDuoStageRequest.md)
+ - [AuthenticatorEmailChallenge](docs/AuthenticatorEmailChallenge.md)
+ - [AuthenticatorEmailChallengeResponseRequest](docs/AuthenticatorEmailChallengeResponseRequest.md)
+ - [AuthenticatorEmailStage](docs/AuthenticatorEmailStage.md)
+ - [AuthenticatorEmailStageRequest](docs/AuthenticatorEmailStageRequest.md)
+ - [AuthenticatorEndpointGDTCStage](docs/AuthenticatorEndpointGDTCStage.md)
+ - [AuthenticatorEndpointGDTCStageRequest](docs/AuthenticatorEndpointGDTCStageRequest.md)
+ - [AuthenticatorSMSChallenge](docs/AuthenticatorSMSChallenge.md)
+ - [AuthenticatorSMSChallengeResponseRequest](docs/AuthenticatorSMSChallengeResponseRequest.md)
+ - [AuthenticatorSMSStage](docs/AuthenticatorSMSStage.md)
+ - [AuthenticatorSMSStageRequest](docs/AuthenticatorSMSStageRequest.md)
+ - [AuthenticatorStaticChallenge](docs/AuthenticatorStaticChallenge.md)
+ - [AuthenticatorStaticChallengeResponseRequest](docs/AuthenticatorStaticChallengeResponseRequest.md)
+ - [AuthenticatorStaticStage](docs/AuthenticatorStaticStage.md)
+ - [AuthenticatorStaticStageRequest](docs/AuthenticatorStaticStageRequest.md)
+ - [AuthenticatorTOTPChallenge](docs/AuthenticatorTOTPChallenge.md)
+ - [AuthenticatorTOTPChallengeResponseRequest](docs/AuthenticatorTOTPChallengeResponseRequest.md)
+ - [AuthenticatorTOTPStage](docs/AuthenticatorTOTPStage.md)
+ - [AuthenticatorTOTPStageRequest](docs/AuthenticatorTOTPStageRequest.md)
+ - [AuthenticatorValidateStage](docs/AuthenticatorValidateStage.md)
+ - [AuthenticatorValidateStageRequest](docs/AuthenticatorValidateStageRequest.md)
+ - [AuthenticatorValidationChallenge](docs/AuthenticatorValidationChallenge.md)
+ - [AuthenticatorValidationChallengeResponseRequest](docs/AuthenticatorValidationChallengeResponseRequest.md)
+ - [AuthenticatorWebAuthnChallenge](docs/AuthenticatorWebAuthnChallenge.md)
+ - [AuthenticatorWebAuthnChallengeResponseRequest](docs/AuthenticatorWebAuthnChallengeResponseRequest.md)
+ - [AuthenticatorWebAuthnStage](docs/AuthenticatorWebAuthnStage.md)
+ - [AuthenticatorWebAuthnStageRequest](docs/AuthenticatorWebAuthnStageRequest.md)
+ - [AuthorizationCodeAuthMethodEnum](docs/AuthorizationCodeAuthMethodEnum.md)
+ - [AutoSubmitChallengeResponseRequest](docs/AutoSubmitChallengeResponseRequest.md)
+ - [AutosubmitChallenge](docs/AutosubmitChallenge.md)
+ - [BackendsEnum](docs/BackendsEnum.md)
+ - [BindingTypeEnum](docs/BindingTypeEnum.md)
+ - [BlueprintFile](docs/BlueprintFile.md)
+ - [BlueprintImportResult](docs/BlueprintImportResult.md)
+ - [BlueprintInstance](docs/BlueprintInstance.md)
+ - [BlueprintInstanceRequest](docs/BlueprintInstanceRequest.md)
+ - [BlueprintInstanceStatusEnum](docs/BlueprintInstanceStatusEnum.md)
+ - [Brand](docs/Brand.md)
+ - [BrandRequest](docs/BrandRequest.md)
+ - [BulkDeleteSessionResponse](docs/BulkDeleteSessionResponse.md)
+ - [Cache](docs/Cache.md)
+ - [CapabilitiesEnum](docs/CapabilitiesEnum.md)
+ - [CaptchaChallenge](docs/CaptchaChallenge.md)
+ - [CaptchaChallengeResponseRequest](docs/CaptchaChallengeResponseRequest.md)
+ - [CaptchaStage](docs/CaptchaStage.md)
+ - [CaptchaStageRequest](docs/CaptchaStageRequest.md)
+ - [CertAttributeEnum](docs/CertAttributeEnum.md)
+ - [CertificateData](docs/CertificateData.md)
+ - [CertificateGenerationRequest](docs/CertificateGenerationRequest.md)
+ - [CertificateKeyPair](docs/CertificateKeyPair.md)
+ - [CertificateKeyPairKeyTypeEnum](docs/CertificateKeyPairKeyTypeEnum.md)
+ - [CertificateKeyPairRequest](docs/CertificateKeyPairRequest.md)
+ - [ChallengeTypes](docs/ChallengeTypes.md)
+ - [ClientTypeEnum](docs/ClientTypeEnum.md)
+ - [CompatibilityModeEnum](docs/CompatibilityModeEnum.md)
+ - [Config](docs/Config.md)
+ - [ConnectionToken](docs/ConnectionToken.md)
+ - [ConnectionTokenRequest](docs/ConnectionTokenRequest.md)
+ - [Connector](docs/Connector.md)
+ - [ConsentChallenge](docs/ConsentChallenge.md)
+ - [ConsentChallengeResponseRequest](docs/ConsentChallengeResponseRequest.md)
+ - [ConsentModeEnum](docs/ConsentModeEnum.md)
+ - [ConsentPermission](docs/ConsentPermission.md)
+ - [ConsentStage](docs/ConsentStage.md)
+ - [ConsentStageRequest](docs/ConsentStageRequest.md)
+ - [ContentType](docs/ContentType.md)
+ - [ContentTypeEnum](docs/ContentTypeEnum.md)
+ - [ContextualFlowInfo](docs/ContextualFlowInfo.md)
+ - [ContextualFlowInfoLayoutEnum](docs/ContextualFlowInfoLayoutEnum.md)
+ - [CountryCodeEnum](docs/CountryCodeEnum.md)
+ - [CurrentBrand](docs/CurrentBrand.md)
+ - [CurrentBrandFlags](docs/CurrentBrandFlags.md)
+ - [DataExport](docs/DataExport.md)
+ - [DeliveryMethodEnum](docs/DeliveryMethodEnum.md)
+ - [DeniedActionEnum](docs/DeniedActionEnum.md)
+ - [DenyStage](docs/DenyStage.md)
+ - [DenyStageRequest](docs/DenyStageRequest.md)
+ - [DetailedCountry](docs/DetailedCountry.md)
+ - [Device](docs/Device.md)
+ - [DeviceAccessGroup](docs/DeviceAccessGroup.md)
+ - [DeviceAccessGroupRequest](docs/DeviceAccessGroupRequest.md)
+ - [DeviceChallenge](docs/DeviceChallenge.md)
+ - [DeviceChallengeRequest](docs/DeviceChallengeRequest.md)
+ - [DeviceClassesEnum](docs/DeviceClassesEnum.md)
+ - [DeviceConnection](docs/DeviceConnection.md)
+ - [DeviceFactSnapshot](docs/DeviceFactSnapshot.md)
+ - [DeviceFacts](docs/DeviceFacts.md)
+ - [DeviceFactsOSFamily](docs/DeviceFactsOSFamily.md)
+ - [DeviceFactsRequest](docs/DeviceFactsRequest.md)
+ - [DeviceGroup](docs/DeviceGroup.md)
+ - [DeviceGroupRequest](docs/DeviceGroupRequest.md)
+ - [DeviceSummary](docs/DeviceSummary.md)
+ - [DeviceUser](docs/DeviceUser.md)
+ - [DeviceUserBinding](docs/DeviceUserBinding.md)
+ - [DeviceUserBindingRequest](docs/DeviceUserBindingRequest.md)
+ - [DeviceUserRequest](docs/DeviceUserRequest.md)
+ - [DigestAlgorithmEnum](docs/DigestAlgorithmEnum.md)
+ - [DigitsEnum](docs/DigitsEnum.md)
+ - [Disk](docs/Disk.md)
+ - [DiskRequest](docs/DiskRequest.md)
+ - [DockerServiceConnection](docs/DockerServiceConnection.md)
+ - [DockerServiceConnectionRequest](docs/DockerServiceConnectionRequest.md)
+ - [Domain](docs/Domain.md)
+ - [DomainRequest](docs/DomainRequest.md)
+ - [DummyChallenge](docs/DummyChallenge.md)
+ - [DummyChallengeResponseRequest](docs/DummyChallengeResponseRequest.md)
+ - [DummyPolicy](docs/DummyPolicy.md)
+ - [DummyPolicyRequest](docs/DummyPolicyRequest.md)
+ - [DummyStage](docs/DummyStage.md)
+ - [DummyStageRequest](docs/DummyStageRequest.md)
+ - [DuoDevice](docs/DuoDevice.md)
+ - [DuoDeviceEnrollmentStatus](docs/DuoDeviceEnrollmentStatus.md)
+ - [DuoDeviceRequest](docs/DuoDeviceRequest.md)
+ - [DuoResponseEnum](docs/DuoResponseEnum.md)
+ - [EmailChallenge](docs/EmailChallenge.md)
+ - [EmailChallengeResponseRequest](docs/EmailChallengeResponseRequest.md)
+ - [EmailDevice](docs/EmailDevice.md)
+ - [EmailDeviceRequest](docs/EmailDeviceRequest.md)
+ - [EmailStage](docs/EmailStage.md)
+ - [EmailStageRequest](docs/EmailStageRequest.md)
+ - [Endpoint](docs/Endpoint.md)
+ - [EndpointAgentChallenge](docs/EndpointAgentChallenge.md)
+ - [EndpointAgentChallengeResponseRequest](docs/EndpointAgentChallengeResponseRequest.md)
+ - [EndpointAuthModeEnum](docs/EndpointAuthModeEnum.md)
+ - [EndpointDevice](docs/EndpointDevice.md)
+ - [EndpointDeviceDetails](docs/EndpointDeviceDetails.md)
+ - [EndpointDeviceRequest](docs/EndpointDeviceRequest.md)
+ - [EndpointRequest](docs/EndpointRequest.md)
+ - [EndpointStage](docs/EndpointStage.md)
+ - [EndpointStageRequest](docs/EndpointStageRequest.md)
+ - [EnrollRequest](docs/EnrollRequest.md)
+ - [EnrollmentToken](docs/EnrollmentToken.md)
+ - [EnrollmentTokenRequest](docs/EnrollmentTokenRequest.md)
+ - [ErrorDetail](docs/ErrorDetail.md)
+ - [ErrorReportingConfig](docs/ErrorReportingConfig.md)
+ - [Event](docs/Event.md)
+ - [EventActions](docs/EventActions.md)
+ - [EventMatcherPolicy](docs/EventMatcherPolicy.md)
+ - [EventMatcherPolicyRequest](docs/EventMatcherPolicyRequest.md)
+ - [EventRequest](docs/EventRequest.md)
+ - [EventStats](docs/EventStats.md)
+ - [EventTopPerUser](docs/EventTopPerUser.md)
+ - [EventVolume](docs/EventVolume.md)
+ - [EventsRequestedEnum](docs/EventsRequestedEnum.md)
+ - [ExpiringBaseGrantModel](docs/ExpiringBaseGrantModel.md)
+ - [ExpressionPolicy](docs/ExpressionPolicy.md)
+ - [ExpressionPolicyRequest](docs/ExpressionPolicyRequest.md)
+ - [ExtraRoleObjectPermission](docs/ExtraRoleObjectPermission.md)
+ - [FileList](docs/FileList.md)
+ - [FleetConnector](docs/FleetConnector.md)
+ - [FleetConnectorRequest](docs/FleetConnectorRequest.md)
+ - [Flow](docs/Flow.md)
+ - [FlowChallengeResponseRequest](docs/FlowChallengeResponseRequest.md)
+ - [FlowDesignationEnum](docs/FlowDesignationEnum.md)
+ - [FlowDiagram](docs/FlowDiagram.md)
+ - [FlowErrorChallenge](docs/FlowErrorChallenge.md)
+ - [FlowInspection](docs/FlowInspection.md)
+ - [FlowInspectorPlan](docs/FlowInspectorPlan.md)
+ - [FlowLayoutEnum](docs/FlowLayoutEnum.md)
+ - [FlowRequest](docs/FlowRequest.md)
+ - [FlowSet](docs/FlowSet.md)
+ - [FlowStageBinding](docs/FlowStageBinding.md)
+ - [FlowStageBindingRequest](docs/FlowStageBindingRequest.md)
+ - [FooterLink](docs/FooterLink.md)
+ - [ForceBindingEnum](docs/ForceBindingEnum.md)
+ - [FormatEnum](docs/FormatEnum.md)
+ - [FrameChallenge](docs/FrameChallenge.md)
+ - [FrameChallengeResponseRequest](docs/FrameChallengeResponseRequest.md)
+ - [GenericError](docs/GenericError.md)
+ - [GeoIPPolicy](docs/GeoIPPolicy.md)
+ - [GeoIPPolicyCountriesObjInner](docs/GeoIPPolicyCountriesObjInner.md)
+ - [GeoIPPolicyRequest](docs/GeoIPPolicyRequest.md)
+ - [GeoipBindingEnum](docs/GeoipBindingEnum.md)
+ - [GlobalTaskStatus](docs/GlobalTaskStatus.md)
+ - [GoogleChromeConnector](docs/GoogleChromeConnector.md)
+ - [GoogleChromeConnectorRequest](docs/GoogleChromeConnectorRequest.md)
+ - [GoogleEndpointDevice](docs/GoogleEndpointDevice.md)
+ - [GoogleEndpointDeviceRequest](docs/GoogleEndpointDeviceRequest.md)
+ - [GoogleWorkspaceProvider](docs/GoogleWorkspaceProvider.md)
+ - [GoogleWorkspaceProviderGroup](docs/GoogleWorkspaceProviderGroup.md)
+ - [GoogleWorkspaceProviderGroupRequest](docs/GoogleWorkspaceProviderGroupRequest.md)
+ - [GoogleWorkspaceProviderMapping](docs/GoogleWorkspaceProviderMapping.md)
+ - [GoogleWorkspaceProviderMappingRequest](docs/GoogleWorkspaceProviderMappingRequest.md)
+ - [GoogleWorkspaceProviderRequest](docs/GoogleWorkspaceProviderRequest.md)
+ - [GoogleWorkspaceProviderUser](docs/GoogleWorkspaceProviderUser.md)
+ - [GoogleWorkspaceProviderUserRequest](docs/GoogleWorkspaceProviderUserRequest.md)
+ - [GrantTypesEnum](docs/GrantTypesEnum.md)
+ - [Group](docs/Group.md)
+ - [GroupKerberosSourceConnection](docs/GroupKerberosSourceConnection.md)
+ - [GroupKerberosSourceConnectionRequest](docs/GroupKerberosSourceConnectionRequest.md)
+ - [GroupLDAPSourceConnection](docs/GroupLDAPSourceConnection.md)
+ - [GroupLDAPSourceConnectionRequest](docs/GroupLDAPSourceConnectionRequest.md)
+ - [GroupMatchingModeEnum](docs/GroupMatchingModeEnum.md)
+ - [GroupOAuthSourceConnection](docs/GroupOAuthSourceConnection.md)
+ - [GroupOAuthSourceConnectionRequest](docs/GroupOAuthSourceConnectionRequest.md)
+ - [GroupPlexSourceConnection](docs/GroupPlexSourceConnection.md)
+ - [GroupPlexSourceConnectionRequest](docs/GroupPlexSourceConnectionRequest.md)
+ - [GroupRequest](docs/GroupRequest.md)
+ - [GroupSAMLSourceConnection](docs/GroupSAMLSourceConnection.md)
+ - [GroupSAMLSourceConnectionRequest](docs/GroupSAMLSourceConnectionRequest.md)
+ - [GroupSourceConnection](docs/GroupSourceConnection.md)
+ - [GroupSourceConnectionRequest](docs/GroupSourceConnectionRequest.md)
+ - [GroupTelegramSourceConnection](docs/GroupTelegramSourceConnection.md)
+ - [GroupTelegramSourceConnectionRequest](docs/GroupTelegramSourceConnectionRequest.md)
+ - [Hardware](docs/Hardware.md)
+ - [HardwareRequest](docs/HardwareRequest.md)
+ - [IdentificationChallenge](docs/IdentificationChallenge.md)
+ - [IdentificationChallengeResponseRequest](docs/IdentificationChallengeResponseRequest.md)
+ - [IdentificationStage](docs/IdentificationStage.md)
+ - [IdentificationStageRequest](docs/IdentificationStageRequest.md)
+ - [IframeLogoutChallenge](docs/IframeLogoutChallenge.md)
+ - [IframeLogoutChallengeResponseRequest](docs/IframeLogoutChallengeResponseRequest.md)
+ - [ImpersonationRequest](docs/ImpersonationRequest.md)
+ - [InitialPermissions](docs/InitialPermissions.md)
+ - [InitialPermissionsRequest](docs/InitialPermissionsRequest.md)
+ - [InstallID](docs/InstallID.md)
+ - [IntentEnum](docs/IntentEnum.md)
+ - [InvalidResponseActionEnum](docs/InvalidResponseActionEnum.md)
+ - [Invitation](docs/Invitation.md)
+ - [InvitationRequest](docs/InvitationRequest.md)
+ - [InvitationSendEmailRequest](docs/InvitationSendEmailRequest.md)
+ - [InvitationStage](docs/InvitationStage.md)
+ - [InvitationStageRequest](docs/InvitationStageRequest.md)
+ - [IssuerModeEnum](docs/IssuerModeEnum.md)
+ - [KadminTypeEnum](docs/KadminTypeEnum.md)
+ - [KerberosSource](docs/KerberosSource.md)
+ - [KerberosSourcePropertyMapping](docs/KerberosSourcePropertyMapping.md)
+ - [KerberosSourcePropertyMappingRequest](docs/KerberosSourcePropertyMappingRequest.md)
+ - [KerberosSourceRequest](docs/KerberosSourceRequest.md)
+ - [KeyTypeEnum](docs/KeyTypeEnum.md)
+ - [KubernetesServiceConnection](docs/KubernetesServiceConnection.md)
+ - [KubernetesServiceConnectionRequest](docs/KubernetesServiceConnectionRequest.md)
+ - [LDAPAPIAccessMode](docs/LDAPAPIAccessMode.md)
+ - [LDAPCheckAccess](docs/LDAPCheckAccess.md)
+ - [LDAPDebug](docs/LDAPDebug.md)
+ - [LDAPOutpostConfig](docs/LDAPOutpostConfig.md)
+ - [LDAPProvider](docs/LDAPProvider.md)
+ - [LDAPProviderRequest](docs/LDAPProviderRequest.md)
+ - [LDAPSource](docs/LDAPSource.md)
+ - [LDAPSourcePropertyMapping](docs/LDAPSourcePropertyMapping.md)
+ - [LDAPSourcePropertyMappingRequest](docs/LDAPSourcePropertyMappingRequest.md)
+ - [LDAPSourceRequest](docs/LDAPSourceRequest.md)
+ - [LangEnum](docs/LangEnum.md)
+ - [LastTaskStatusEnum](docs/LastTaskStatusEnum.md)
+ - [License](docs/License.md)
+ - [LicenseFlagsEnum](docs/LicenseFlagsEnum.md)
+ - [LicenseForecast](docs/LicenseForecast.md)
+ - [LicenseRequest](docs/LicenseRequest.md)
+ - [LicenseStatusEnum](docs/LicenseStatusEnum.md)
+ - [LicenseSummary](docs/LicenseSummary.md)
+ - [LicenseSummaryStatusEnum](docs/LicenseSummaryStatusEnum.md)
+ - [LifecycleIteration](docs/LifecycleIteration.md)
+ - [LifecycleIterationRequest](docs/LifecycleIterationRequest.md)
+ - [LifecycleIterationStateEnum](docs/LifecycleIterationStateEnum.md)
+ - [LifecycleRule](docs/LifecycleRule.md)
+ - [LifecycleRuleRequest](docs/LifecycleRuleRequest.md)
+ - [Link](docs/Link.md)
+ - [LogEvent](docs/LogEvent.md)
+ - [LogLevelEnum](docs/LogLevelEnum.md)
+ - [LoginChallengeTypes](docs/LoginChallengeTypes.md)
+ - [LoginSource](docs/LoginSource.md)
+ - [LogoutURL](docs/LogoutURL.md)
+ - [MDMConfigRequest](docs/MDMConfigRequest.md)
+ - [MDMConfigResponse](docs/MDMConfigResponse.md)
+ - [MatchingModeEnum](docs/MatchingModeEnum.md)
+ - [Metadata](docs/Metadata.md)
+ - [MicrosoftEntraProvider](docs/MicrosoftEntraProvider.md)
+ - [MicrosoftEntraProviderGroup](docs/MicrosoftEntraProviderGroup.md)
+ - [MicrosoftEntraProviderGroupRequest](docs/MicrosoftEntraProviderGroupRequest.md)
+ - [MicrosoftEntraProviderMapping](docs/MicrosoftEntraProviderMapping.md)
+ - [MicrosoftEntraProviderMappingRequest](docs/MicrosoftEntraProviderMappingRequest.md)
+ - [MicrosoftEntraProviderRequest](docs/MicrosoftEntraProviderRequest.md)
+ - [MicrosoftEntraProviderUser](docs/MicrosoftEntraProviderUser.md)
+ - [MicrosoftEntraProviderUserRequest](docs/MicrosoftEntraProviderUserRequest.md)
+ - [ModelEnum](docs/ModelEnum.md)
+ - [ModelRequest](docs/ModelRequest.md)
+ - [MutualTLSStage](docs/MutualTLSStage.md)
+ - [MutualTLSStageRequest](docs/MutualTLSStageRequest.md)
+ - [NativeLogoutChallenge](docs/NativeLogoutChallenge.md)
+ - [NativeLogoutChallengeResponseRequest](docs/NativeLogoutChallengeResponseRequest.md)
+ - [Network](docs/Network.md)
+ - [NetworkBindingEnum](docs/NetworkBindingEnum.md)
+ - [NetworkInterface](docs/NetworkInterface.md)
+ - [NetworkInterfaceRequest](docs/NetworkInterfaceRequest.md)
+ - [NetworkRequest](docs/NetworkRequest.md)
+ - [NotConfiguredActionEnum](docs/NotConfiguredActionEnum.md)
+ - [Notification](docs/Notification.md)
+ - [NotificationRequest](docs/NotificationRequest.md)
+ - [NotificationRule](docs/NotificationRule.md)
+ - [NotificationRuleRequest](docs/NotificationRuleRequest.md)
+ - [NotificationTransport](docs/NotificationTransport.md)
+ - [NotificationTransportRequest](docs/NotificationTransportRequest.md)
+ - [NotificationTransportTest](docs/NotificationTransportTest.md)
+ - [NotificationWebhookMapping](docs/NotificationWebhookMapping.md)
+ - [NotificationWebhookMappingRequest](docs/NotificationWebhookMappingRequest.md)
+ - [OAuth2Provider](docs/OAuth2Provider.md)
+ - [OAuth2ProviderLogoutMethodEnum](docs/OAuth2ProviderLogoutMethodEnum.md)
+ - [OAuth2ProviderRequest](docs/OAuth2ProviderRequest.md)
+ - [OAuth2ProviderSetupURLs](docs/OAuth2ProviderSetupURLs.md)
+ - [OAuthDeviceCodeChallenge](docs/OAuthDeviceCodeChallenge.md)
+ - [OAuthDeviceCodeChallengeResponseRequest](docs/OAuthDeviceCodeChallengeResponseRequest.md)
+ - [OAuthDeviceCodeFinishChallenge](docs/OAuthDeviceCodeFinishChallenge.md)
+ - [OAuthDeviceCodeFinishChallengeResponseRequest](docs/OAuthDeviceCodeFinishChallengeResponseRequest.md)
+ - [OAuthSource](docs/OAuthSource.md)
+ - [OAuthSourcePropertyMapping](docs/OAuthSourcePropertyMapping.md)
+ - [OAuthSourcePropertyMappingRequest](docs/OAuthSourcePropertyMappingRequest.md)
+ - [OAuthSourceRequest](docs/OAuthSourceRequest.md)
+ - [OpenIDConnectConfiguration](docs/OpenIDConnectConfiguration.md)
+ - [OperatingSystem](docs/OperatingSystem.md)
+ - [OperatingSystemRequest](docs/OperatingSystemRequest.md)
+ - [OutgoingSyncDeleteAction](docs/OutgoingSyncDeleteAction.md)
+ - [Outpost](docs/Outpost.md)
+ - [OutpostDefaultConfig](docs/OutpostDefaultConfig.md)
+ - [OutpostHealth](docs/OutpostHealth.md)
+ - [OutpostRequest](docs/OutpostRequest.md)
+ - [OutpostTypeEnum](docs/OutpostTypeEnum.md)
+ - [PKCEMethodEnum](docs/PKCEMethodEnum.md)
+ - [PaginatedAccountLockdownStageList](docs/PaginatedAccountLockdownStageList.md)
+ - [PaginatedAgentConnectorList](docs/PaginatedAgentConnectorList.md)
+ - [PaginatedAppleIndependentSecureEnclaveList](docs/PaginatedAppleIndependentSecureEnclaveList.md)
+ - [PaginatedApplicationEntitlementList](docs/PaginatedApplicationEntitlementList.md)
+ - [PaginatedApplicationList](docs/PaginatedApplicationList.md)
+ - [PaginatedAuthenticatedSessionList](docs/PaginatedAuthenticatedSessionList.md)
+ - [PaginatedAuthenticatorDuoStageList](docs/PaginatedAuthenticatorDuoStageList.md)
+ - [PaginatedAuthenticatorEmailStageList](docs/PaginatedAuthenticatorEmailStageList.md)
+ - [PaginatedAuthenticatorEndpointGDTCStageList](docs/PaginatedAuthenticatorEndpointGDTCStageList.md)
+ - [PaginatedAuthenticatorSMSStageList](docs/PaginatedAuthenticatorSMSStageList.md)
+ - [PaginatedAuthenticatorStaticStageList](docs/PaginatedAuthenticatorStaticStageList.md)
+ - [PaginatedAuthenticatorTOTPStageList](docs/PaginatedAuthenticatorTOTPStageList.md)
+ - [PaginatedAuthenticatorValidateStageList](docs/PaginatedAuthenticatorValidateStageList.md)
+ - [PaginatedAuthenticatorWebAuthnStageList](docs/PaginatedAuthenticatorWebAuthnStageList.md)
+ - [PaginatedBlueprintInstanceList](docs/PaginatedBlueprintInstanceList.md)
+ - [PaginatedBrandList](docs/PaginatedBrandList.md)
+ - [PaginatedCaptchaStageList](docs/PaginatedCaptchaStageList.md)
+ - [PaginatedCertificateKeyPairList](docs/PaginatedCertificateKeyPairList.md)
+ - [PaginatedConnectionTokenList](docs/PaginatedConnectionTokenList.md)
+ - [PaginatedConnectorList](docs/PaginatedConnectorList.md)
+ - [PaginatedConsentStageList](docs/PaginatedConsentStageList.md)
+ - [PaginatedDataExportList](docs/PaginatedDataExportList.md)
+ - [PaginatedDenyStageList](docs/PaginatedDenyStageList.md)
+ - [PaginatedDeviceAccessGroupList](docs/PaginatedDeviceAccessGroupList.md)
+ - [PaginatedDeviceUserBindingList](docs/PaginatedDeviceUserBindingList.md)
+ - [PaginatedDockerServiceConnectionList](docs/PaginatedDockerServiceConnectionList.md)
+ - [PaginatedDomainList](docs/PaginatedDomainList.md)
+ - [PaginatedDummyPolicyList](docs/PaginatedDummyPolicyList.md)
+ - [PaginatedDummyStageList](docs/PaginatedDummyStageList.md)
+ - [PaginatedDuoDeviceList](docs/PaginatedDuoDeviceList.md)
+ - [PaginatedEmailDeviceList](docs/PaginatedEmailDeviceList.md)
+ - [PaginatedEmailStageList](docs/PaginatedEmailStageList.md)
+ - [PaginatedEndpointDeviceList](docs/PaginatedEndpointDeviceList.md)
+ - [PaginatedEndpointList](docs/PaginatedEndpointList.md)
+ - [PaginatedEndpointStageList](docs/PaginatedEndpointStageList.md)
+ - [PaginatedEnrollmentTokenList](docs/PaginatedEnrollmentTokenList.md)
+ - [PaginatedEventList](docs/PaginatedEventList.md)
+ - [PaginatedEventMatcherPolicyList](docs/PaginatedEventMatcherPolicyList.md)
+ - [PaginatedExpiringBaseGrantModelList](docs/PaginatedExpiringBaseGrantModelList.md)
+ - [PaginatedExpressionPolicyList](docs/PaginatedExpressionPolicyList.md)
+ - [PaginatedExtraRoleObjectPermissionList](docs/PaginatedExtraRoleObjectPermissionList.md)
+ - [PaginatedFleetConnectorList](docs/PaginatedFleetConnectorList.md)
+ - [PaginatedFlowList](docs/PaginatedFlowList.md)
+ - [PaginatedFlowStageBindingList](docs/PaginatedFlowStageBindingList.md)
+ - [PaginatedGeoIPPolicyList](docs/PaginatedGeoIPPolicyList.md)
+ - [PaginatedGoogleChromeConnectorList](docs/PaginatedGoogleChromeConnectorList.md)
+ - [PaginatedGoogleEndpointDeviceList](docs/PaginatedGoogleEndpointDeviceList.md)
+ - [PaginatedGoogleWorkspaceProviderGroupList](docs/PaginatedGoogleWorkspaceProviderGroupList.md)
+ - [PaginatedGoogleWorkspaceProviderList](docs/PaginatedGoogleWorkspaceProviderList.md)
+ - [PaginatedGoogleWorkspaceProviderMappingList](docs/PaginatedGoogleWorkspaceProviderMappingList.md)
+ - [PaginatedGoogleWorkspaceProviderUserList](docs/PaginatedGoogleWorkspaceProviderUserList.md)
+ - [PaginatedGroupKerberosSourceConnectionList](docs/PaginatedGroupKerberosSourceConnectionList.md)
+ - [PaginatedGroupLDAPSourceConnectionList](docs/PaginatedGroupLDAPSourceConnectionList.md)
+ - [PaginatedGroupList](docs/PaginatedGroupList.md)
+ - [PaginatedGroupOAuthSourceConnectionList](docs/PaginatedGroupOAuthSourceConnectionList.md)
+ - [PaginatedGroupPlexSourceConnectionList](docs/PaginatedGroupPlexSourceConnectionList.md)
+ - [PaginatedGroupSAMLSourceConnectionList](docs/PaginatedGroupSAMLSourceConnectionList.md)
+ - [PaginatedGroupSourceConnectionList](docs/PaginatedGroupSourceConnectionList.md)
+ - [PaginatedGroupTelegramSourceConnectionList](docs/PaginatedGroupTelegramSourceConnectionList.md)
+ - [PaginatedIdentificationStageList](docs/PaginatedIdentificationStageList.md)
+ - [PaginatedInitialPermissionsList](docs/PaginatedInitialPermissionsList.md)
+ - [PaginatedInvitationList](docs/PaginatedInvitationList.md)
+ - [PaginatedInvitationStageList](docs/PaginatedInvitationStageList.md)
+ - [PaginatedKerberosSourceList](docs/PaginatedKerberosSourceList.md)
+ - [PaginatedKerberosSourcePropertyMappingList](docs/PaginatedKerberosSourcePropertyMappingList.md)
+ - [PaginatedKubernetesServiceConnectionList](docs/PaginatedKubernetesServiceConnectionList.md)
+ - [PaginatedLDAPOutpostConfigList](docs/PaginatedLDAPOutpostConfigList.md)
+ - [PaginatedLDAPProviderList](docs/PaginatedLDAPProviderList.md)
+ - [PaginatedLDAPSourceList](docs/PaginatedLDAPSourceList.md)
+ - [PaginatedLDAPSourcePropertyMappingList](docs/PaginatedLDAPSourcePropertyMappingList.md)
+ - [PaginatedLicenseList](docs/PaginatedLicenseList.md)
+ - [PaginatedLifecycleIterationList](docs/PaginatedLifecycleIterationList.md)
+ - [PaginatedLifecycleRuleList](docs/PaginatedLifecycleRuleList.md)
+ - [PaginatedMicrosoftEntraProviderGroupList](docs/PaginatedMicrosoftEntraProviderGroupList.md)
+ - [PaginatedMicrosoftEntraProviderList](docs/PaginatedMicrosoftEntraProviderList.md)
+ - [PaginatedMicrosoftEntraProviderMappingList](docs/PaginatedMicrosoftEntraProviderMappingList.md)
+ - [PaginatedMicrosoftEntraProviderUserList](docs/PaginatedMicrosoftEntraProviderUserList.md)
+ - [PaginatedMutualTLSStageList](docs/PaginatedMutualTLSStageList.md)
+ - [PaginatedNotificationList](docs/PaginatedNotificationList.md)
+ - [PaginatedNotificationRuleList](docs/PaginatedNotificationRuleList.md)
+ - [PaginatedNotificationTransportList](docs/PaginatedNotificationTransportList.md)
+ - [PaginatedNotificationWebhookMappingList](docs/PaginatedNotificationWebhookMappingList.md)
+ - [PaginatedOAuth2ProviderList](docs/PaginatedOAuth2ProviderList.md)
+ - [PaginatedOAuthSourceList](docs/PaginatedOAuthSourceList.md)
+ - [PaginatedOAuthSourcePropertyMappingList](docs/PaginatedOAuthSourcePropertyMappingList.md)
+ - [PaginatedOutpostList](docs/PaginatedOutpostList.md)
+ - [PaginatedPasswordExpiryPolicyList](docs/PaginatedPasswordExpiryPolicyList.md)
+ - [PaginatedPasswordPolicyList](docs/PaginatedPasswordPolicyList.md)
+ - [PaginatedPasswordStageList](docs/PaginatedPasswordStageList.md)
+ - [PaginatedPermissionList](docs/PaginatedPermissionList.md)
+ - [PaginatedPlexSourceList](docs/PaginatedPlexSourceList.md)
+ - [PaginatedPlexSourcePropertyMappingList](docs/PaginatedPlexSourcePropertyMappingList.md)
+ - [PaginatedPolicyBindingList](docs/PaginatedPolicyBindingList.md)
+ - [PaginatedPolicyList](docs/PaginatedPolicyList.md)
+ - [PaginatedPromptList](docs/PaginatedPromptList.md)
+ - [PaginatedPromptStageList](docs/PaginatedPromptStageList.md)
+ - [PaginatedPropertyMappingList](docs/PaginatedPropertyMappingList.md)
+ - [PaginatedProviderList](docs/PaginatedProviderList.md)
+ - [PaginatedProxyOutpostConfigList](docs/PaginatedProxyOutpostConfigList.md)
+ - [PaginatedProxyProviderList](docs/PaginatedProxyProviderList.md)
+ - [PaginatedRACPropertyMappingList](docs/PaginatedRACPropertyMappingList.md)
+ - [PaginatedRACProviderList](docs/PaginatedRACProviderList.md)
+ - [PaginatedRadiusOutpostConfigList](docs/PaginatedRadiusOutpostConfigList.md)
+ - [PaginatedRadiusProviderList](docs/PaginatedRadiusProviderList.md)
+ - [PaginatedRadiusProviderPropertyMappingList](docs/PaginatedRadiusProviderPropertyMappingList.md)
+ - [PaginatedRedirectStageList](docs/PaginatedRedirectStageList.md)
+ - [PaginatedReputationList](docs/PaginatedReputationList.md)
+ - [PaginatedReputationPolicyList](docs/PaginatedReputationPolicyList.md)
+ - [PaginatedRoleAssignedObjectPermissionList](docs/PaginatedRoleAssignedObjectPermissionList.md)
+ - [PaginatedRoleList](docs/PaginatedRoleList.md)
+ - [PaginatedSAMLPropertyMappingList](docs/PaginatedSAMLPropertyMappingList.md)
+ - [PaginatedSAMLProviderList](docs/PaginatedSAMLProviderList.md)
+ - [PaginatedSAMLSourceList](docs/PaginatedSAMLSourceList.md)
+ - [PaginatedSAMLSourcePropertyMappingList](docs/PaginatedSAMLSourcePropertyMappingList.md)
+ - [PaginatedSCIMMappingList](docs/PaginatedSCIMMappingList.md)
+ - [PaginatedSCIMProviderGroupList](docs/PaginatedSCIMProviderGroupList.md)
+ - [PaginatedSCIMProviderList](docs/PaginatedSCIMProviderList.md)
+ - [PaginatedSCIMProviderUserList](docs/PaginatedSCIMProviderUserList.md)
+ - [PaginatedSCIMSourceGroupList](docs/PaginatedSCIMSourceGroupList.md)
+ - [PaginatedSCIMSourceList](docs/PaginatedSCIMSourceList.md)
+ - [PaginatedSCIMSourcePropertyMappingList](docs/PaginatedSCIMSourcePropertyMappingList.md)
+ - [PaginatedSCIMSourceUserList](docs/PaginatedSCIMSourceUserList.md)
+ - [PaginatedSMSDeviceList](docs/PaginatedSMSDeviceList.md)
+ - [PaginatedSSFProviderList](docs/PaginatedSSFProviderList.md)
+ - [PaginatedSSFStreamList](docs/PaginatedSSFStreamList.md)
+ - [PaginatedScheduleList](docs/PaginatedScheduleList.md)
+ - [PaginatedScopeMappingList](docs/PaginatedScopeMappingList.md)
+ - [PaginatedServiceConnectionList](docs/PaginatedServiceConnectionList.md)
+ - [PaginatedSourceList](docs/PaginatedSourceList.md)
+ - [PaginatedSourceStageList](docs/PaginatedSourceStageList.md)
+ - [PaginatedStageList](docs/PaginatedStageList.md)
+ - [PaginatedStaticDeviceList](docs/PaginatedStaticDeviceList.md)
+ - [PaginatedTOTPDeviceList](docs/PaginatedTOTPDeviceList.md)
+ - [PaginatedTaskList](docs/PaginatedTaskList.md)
+ - [PaginatedTelegramSourceList](docs/PaginatedTelegramSourceList.md)
+ - [PaginatedTelegramSourcePropertyMappingList](docs/PaginatedTelegramSourcePropertyMappingList.md)
+ - [PaginatedTenantList](docs/PaginatedTenantList.md)
+ - [PaginatedTokenList](docs/PaginatedTokenList.md)
+ - [PaginatedTokenModelList](docs/PaginatedTokenModelList.md)
+ - [PaginatedUniquePasswordPolicyList](docs/PaginatedUniquePasswordPolicyList.md)
+ - [PaginatedUserConsentList](docs/PaginatedUserConsentList.md)
+ - [PaginatedUserDeleteStageList](docs/PaginatedUserDeleteStageList.md)
+ - [PaginatedUserKerberosSourceConnectionList](docs/PaginatedUserKerberosSourceConnectionList.md)
+ - [PaginatedUserLDAPSourceConnectionList](docs/PaginatedUserLDAPSourceConnectionList.md)
+ - [PaginatedUserList](docs/PaginatedUserList.md)
+ - [PaginatedUserLoginStageList](docs/PaginatedUserLoginStageList.md)
+ - [PaginatedUserLogoutStageList](docs/PaginatedUserLogoutStageList.md)
+ - [PaginatedUserOAuthSourceConnectionList](docs/PaginatedUserOAuthSourceConnectionList.md)
+ - [PaginatedUserPlexSourceConnectionList](docs/PaginatedUserPlexSourceConnectionList.md)
+ - [PaginatedUserSAMLSourceConnectionList](docs/PaginatedUserSAMLSourceConnectionList.md)
+ - [PaginatedUserSourceConnectionList](docs/PaginatedUserSourceConnectionList.md)
+ - [PaginatedUserTelegramSourceConnectionList](docs/PaginatedUserTelegramSourceConnectionList.md)
+ - [PaginatedUserWriteStageList](docs/PaginatedUserWriteStageList.md)
+ - [PaginatedWSFederationProviderList](docs/PaginatedWSFederationProviderList.md)
+ - [PaginatedWebAuthnDeviceList](docs/PaginatedWebAuthnDeviceList.md)
+ - [PaginatedWebAuthnDeviceTypeList](docs/PaginatedWebAuthnDeviceTypeList.md)
+ - [Pagination](docs/Pagination.md)
+ - [PartialGroup](docs/PartialGroup.md)
+ - [PartialUser](docs/PartialUser.md)
+ - [PasswordChallenge](docs/PasswordChallenge.md)
+ - [PasswordChallengeResponseRequest](docs/PasswordChallengeResponseRequest.md)
+ - [PasswordExpiryPolicy](docs/PasswordExpiryPolicy.md)
+ - [PasswordExpiryPolicyRequest](docs/PasswordExpiryPolicyRequest.md)
+ - [PasswordPolicy](docs/PasswordPolicy.md)
+ - [PasswordPolicyRequest](docs/PasswordPolicyRequest.md)
+ - [PasswordStage](docs/PasswordStage.md)
+ - [PasswordStageRequest](docs/PasswordStageRequest.md)
+ - [PatchedAccountLockdownStageRequest](docs/PatchedAccountLockdownStageRequest.md)
+ - [PatchedAgentConnectorRequest](docs/PatchedAgentConnectorRequest.md)
+ - [PatchedAppleIndependentSecureEnclaveRequest](docs/PatchedAppleIndependentSecureEnclaveRequest.md)
+ - [PatchedApplicationEntitlementRequest](docs/PatchedApplicationEntitlementRequest.md)
+ - [PatchedApplicationRequest](docs/PatchedApplicationRequest.md)
+ - [PatchedAuthenticatorDuoStageRequest](docs/PatchedAuthenticatorDuoStageRequest.md)
+ - [PatchedAuthenticatorEmailStageRequest](docs/PatchedAuthenticatorEmailStageRequest.md)
+ - [PatchedAuthenticatorEndpointGDTCStageRequest](docs/PatchedAuthenticatorEndpointGDTCStageRequest.md)
+ - [PatchedAuthenticatorSMSStageRequest](docs/PatchedAuthenticatorSMSStageRequest.md)
+ - [PatchedAuthenticatorStaticStageRequest](docs/PatchedAuthenticatorStaticStageRequest.md)
+ - [PatchedAuthenticatorTOTPStageRequest](docs/PatchedAuthenticatorTOTPStageRequest.md)
+ - [PatchedAuthenticatorValidateStageRequest](docs/PatchedAuthenticatorValidateStageRequest.md)
+ - [PatchedAuthenticatorWebAuthnStageRequest](docs/PatchedAuthenticatorWebAuthnStageRequest.md)
+ - [PatchedBlueprintInstanceRequest](docs/PatchedBlueprintInstanceRequest.md)
+ - [PatchedBrandRequest](docs/PatchedBrandRequest.md)
+ - [PatchedCaptchaStageRequest](docs/PatchedCaptchaStageRequest.md)
+ - [PatchedCertificateKeyPairRequest](docs/PatchedCertificateKeyPairRequest.md)
+ - [PatchedConnectionTokenRequest](docs/PatchedConnectionTokenRequest.md)
+ - [PatchedConsentStageRequest](docs/PatchedConsentStageRequest.md)
+ - [PatchedDenyStageRequest](docs/PatchedDenyStageRequest.md)
+ - [PatchedDeviceAccessGroupRequest](docs/PatchedDeviceAccessGroupRequest.md)
+ - [PatchedDeviceUserBindingRequest](docs/PatchedDeviceUserBindingRequest.md)
+ - [PatchedDockerServiceConnectionRequest](docs/PatchedDockerServiceConnectionRequest.md)
+ - [PatchedDomainRequest](docs/PatchedDomainRequest.md)
+ - [PatchedDummyPolicyRequest](docs/PatchedDummyPolicyRequest.md)
+ - [PatchedDummyStageRequest](docs/PatchedDummyStageRequest.md)
+ - [PatchedDuoDeviceRequest](docs/PatchedDuoDeviceRequest.md)
+ - [PatchedEmailDeviceRequest](docs/PatchedEmailDeviceRequest.md)
+ - [PatchedEmailStageRequest](docs/PatchedEmailStageRequest.md)
+ - [PatchedEndpointDeviceRequest](docs/PatchedEndpointDeviceRequest.md)
+ - [PatchedEndpointRequest](docs/PatchedEndpointRequest.md)
+ - [PatchedEndpointStageRequest](docs/PatchedEndpointStageRequest.md)
+ - [PatchedEnrollmentTokenRequest](docs/PatchedEnrollmentTokenRequest.md)
+ - [PatchedEventMatcherPolicyRequest](docs/PatchedEventMatcherPolicyRequest.md)
+ - [PatchedEventRequest](docs/PatchedEventRequest.md)
+ - [PatchedExpressionPolicyRequest](docs/PatchedExpressionPolicyRequest.md)
+ - [PatchedFleetConnectorRequest](docs/PatchedFleetConnectorRequest.md)
+ - [PatchedFlowRequest](docs/PatchedFlowRequest.md)
+ - [PatchedFlowStageBindingRequest](docs/PatchedFlowStageBindingRequest.md)
+ - [PatchedGeoIPPolicyRequest](docs/PatchedGeoIPPolicyRequest.md)
+ - [PatchedGoogleChromeConnectorRequest](docs/PatchedGoogleChromeConnectorRequest.md)
+ - [PatchedGoogleEndpointDeviceRequest](docs/PatchedGoogleEndpointDeviceRequest.md)
+ - [PatchedGoogleWorkspaceProviderMappingRequest](docs/PatchedGoogleWorkspaceProviderMappingRequest.md)
+ - [PatchedGoogleWorkspaceProviderRequest](docs/PatchedGoogleWorkspaceProviderRequest.md)
+ - [PatchedGroupKerberosSourceConnectionRequest](docs/PatchedGroupKerberosSourceConnectionRequest.md)
+ - [PatchedGroupLDAPSourceConnectionRequest](docs/PatchedGroupLDAPSourceConnectionRequest.md)
+ - [PatchedGroupOAuthSourceConnectionRequest](docs/PatchedGroupOAuthSourceConnectionRequest.md)
+ - [PatchedGroupPlexSourceConnectionRequest](docs/PatchedGroupPlexSourceConnectionRequest.md)
+ - [PatchedGroupRequest](docs/PatchedGroupRequest.md)
+ - [PatchedGroupSAMLSourceConnectionRequest](docs/PatchedGroupSAMLSourceConnectionRequest.md)
+ - [PatchedGroupSourceConnectionRequest](docs/PatchedGroupSourceConnectionRequest.md)
+ - [PatchedGroupTelegramSourceConnectionRequest](docs/PatchedGroupTelegramSourceConnectionRequest.md)
+ - [PatchedIdentificationStageRequest](docs/PatchedIdentificationStageRequest.md)
+ - [PatchedInitialPermissionsRequest](docs/PatchedInitialPermissionsRequest.md)
+ - [PatchedInvitationRequest](docs/PatchedInvitationRequest.md)
+ - [PatchedInvitationStageRequest](docs/PatchedInvitationStageRequest.md)
+ - [PatchedKerberosSourcePropertyMappingRequest](docs/PatchedKerberosSourcePropertyMappingRequest.md)
+ - [PatchedKerberosSourceRequest](docs/PatchedKerberosSourceRequest.md)
+ - [PatchedKubernetesServiceConnectionRequest](docs/PatchedKubernetesServiceConnectionRequest.md)
+ - [PatchedLDAPProviderRequest](docs/PatchedLDAPProviderRequest.md)
+ - [PatchedLDAPSourcePropertyMappingRequest](docs/PatchedLDAPSourcePropertyMappingRequest.md)
+ - [PatchedLDAPSourceRequest](docs/PatchedLDAPSourceRequest.md)
+ - [PatchedLicenseRequest](docs/PatchedLicenseRequest.md)
+ - [PatchedLifecycleRuleRequest](docs/PatchedLifecycleRuleRequest.md)
+ - [PatchedMicrosoftEntraProviderMappingRequest](docs/PatchedMicrosoftEntraProviderMappingRequest.md)
+ - [PatchedMicrosoftEntraProviderRequest](docs/PatchedMicrosoftEntraProviderRequest.md)
+ - [PatchedMutualTLSStageRequest](docs/PatchedMutualTLSStageRequest.md)
+ - [PatchedNotificationRequest](docs/PatchedNotificationRequest.md)
+ - [PatchedNotificationRuleRequest](docs/PatchedNotificationRuleRequest.md)
+ - [PatchedNotificationTransportRequest](docs/PatchedNotificationTransportRequest.md)
+ - [PatchedNotificationWebhookMappingRequest](docs/PatchedNotificationWebhookMappingRequest.md)
+ - [PatchedOAuth2ProviderRequest](docs/PatchedOAuth2ProviderRequest.md)
+ - [PatchedOAuthSourcePropertyMappingRequest](docs/PatchedOAuthSourcePropertyMappingRequest.md)
+ - [PatchedOAuthSourceRequest](docs/PatchedOAuthSourceRequest.md)
+ - [PatchedOutpostRequest](docs/PatchedOutpostRequest.md)
+ - [PatchedPasswordExpiryPolicyRequest](docs/PatchedPasswordExpiryPolicyRequest.md)
+ - [PatchedPasswordPolicyRequest](docs/PatchedPasswordPolicyRequest.md)
+ - [PatchedPasswordStageRequest](docs/PatchedPasswordStageRequest.md)
+ - [PatchedPermissionAssignRequest](docs/PatchedPermissionAssignRequest.md)
+ - [PatchedPlexSourcePropertyMappingRequest](docs/PatchedPlexSourcePropertyMappingRequest.md)
+ - [PatchedPlexSourceRequest](docs/PatchedPlexSourceRequest.md)
+ - [PatchedPolicyBindingRequest](docs/PatchedPolicyBindingRequest.md)
+ - [PatchedPromptRequest](docs/PatchedPromptRequest.md)
+ - [PatchedPromptStageRequest](docs/PatchedPromptStageRequest.md)
+ - [PatchedProxyProviderRequest](docs/PatchedProxyProviderRequest.md)
+ - [PatchedRACPropertyMappingRequest](docs/PatchedRACPropertyMappingRequest.md)
+ - [PatchedRACProviderRequest](docs/PatchedRACProviderRequest.md)
+ - [PatchedRadiusProviderPropertyMappingRequest](docs/PatchedRadiusProviderPropertyMappingRequest.md)
+ - [PatchedRadiusProviderRequest](docs/PatchedRadiusProviderRequest.md)
+ - [PatchedRedirectStageRequest](docs/PatchedRedirectStageRequest.md)
+ - [PatchedReputationPolicyRequest](docs/PatchedReputationPolicyRequest.md)
+ - [PatchedRoleRequest](docs/PatchedRoleRequest.md)
+ - [PatchedSAMLPropertyMappingRequest](docs/PatchedSAMLPropertyMappingRequest.md)
+ - [PatchedSAMLProviderRequest](docs/PatchedSAMLProviderRequest.md)
+ - [PatchedSAMLSourcePropertyMappingRequest](docs/PatchedSAMLSourcePropertyMappingRequest.md)
+ - [PatchedSAMLSourceRequest](docs/PatchedSAMLSourceRequest.md)
+ - [PatchedSCIMMappingRequest](docs/PatchedSCIMMappingRequest.md)
+ - [PatchedSCIMProviderRequest](docs/PatchedSCIMProviderRequest.md)
+ - [PatchedSCIMSourceGroupRequest](docs/PatchedSCIMSourceGroupRequest.md)
+ - [PatchedSCIMSourcePropertyMappingRequest](docs/PatchedSCIMSourcePropertyMappingRequest.md)
+ - [PatchedSCIMSourceRequest](docs/PatchedSCIMSourceRequest.md)
+ - [PatchedSCIMSourceUserRequest](docs/PatchedSCIMSourceUserRequest.md)
+ - [PatchedSMSDeviceRequest](docs/PatchedSMSDeviceRequest.md)
+ - [PatchedSSFProviderRequest](docs/PatchedSSFProviderRequest.md)
+ - [PatchedScheduleRequest](docs/PatchedScheduleRequest.md)
+ - [PatchedScopeMappingRequest](docs/PatchedScopeMappingRequest.md)
+ - [PatchedSettingsRequest](docs/PatchedSettingsRequest.md)
+ - [PatchedSettingsRequestFlags](docs/PatchedSettingsRequestFlags.md)
+ - [PatchedSourceStageRequest](docs/PatchedSourceStageRequest.md)
+ - [PatchedStaticDeviceRequest](docs/PatchedStaticDeviceRequest.md)
+ - [PatchedTOTPDeviceRequest](docs/PatchedTOTPDeviceRequest.md)
+ - [PatchedTelegramSourcePropertyMappingRequest](docs/PatchedTelegramSourcePropertyMappingRequest.md)
+ - [PatchedTelegramSourceRequest](docs/PatchedTelegramSourceRequest.md)
+ - [PatchedTenantRequest](docs/PatchedTenantRequest.md)
+ - [PatchedTokenRequest](docs/PatchedTokenRequest.md)
+ - [PatchedUniquePasswordPolicyRequest](docs/PatchedUniquePasswordPolicyRequest.md)
+ - [PatchedUserDeleteStageRequest](docs/PatchedUserDeleteStageRequest.md)
+ - [PatchedUserKerberosSourceConnectionRequest](docs/PatchedUserKerberosSourceConnectionRequest.md)
+ - [PatchedUserLDAPSourceConnectionRequest](docs/PatchedUserLDAPSourceConnectionRequest.md)
+ - [PatchedUserLoginStageRequest](docs/PatchedUserLoginStageRequest.md)
+ - [PatchedUserLogoutStageRequest](docs/PatchedUserLogoutStageRequest.md)
+ - [PatchedUserOAuthSourceConnectionRequest](docs/PatchedUserOAuthSourceConnectionRequest.md)
+ - [PatchedUserPlexSourceConnectionRequest](docs/PatchedUserPlexSourceConnectionRequest.md)
+ - [PatchedUserRequest](docs/PatchedUserRequest.md)
+ - [PatchedUserSAMLSourceConnectionRequest](docs/PatchedUserSAMLSourceConnectionRequest.md)
+ - [PatchedUserSourceConnectionRequest](docs/PatchedUserSourceConnectionRequest.md)
+ - [PatchedUserTelegramSourceConnectionRequest](docs/PatchedUserTelegramSourceConnectionRequest.md)
+ - [PatchedUserWriteStageRequest](docs/PatchedUserWriteStageRequest.md)
+ - [PatchedWSFederationProviderRequest](docs/PatchedWSFederationProviderRequest.md)
+ - [PatchedWebAuthnDeviceRequest](docs/PatchedWebAuthnDeviceRequest.md)
+ - [Permission](docs/Permission.md)
+ - [PermissionAssignRequest](docs/PermissionAssignRequest.md)
+ - [PermissionAssignResult](docs/PermissionAssignResult.md)
+ - [PlexAuthenticationChallenge](docs/PlexAuthenticationChallenge.md)
+ - [PlexAuthenticationChallengeResponseRequest](docs/PlexAuthenticationChallengeResponseRequest.md)
+ - [PlexSource](docs/PlexSource.md)
+ - [PlexSourcePropertyMapping](docs/PlexSourcePropertyMapping.md)
+ - [PlexSourcePropertyMappingRequest](docs/PlexSourcePropertyMappingRequest.md)
+ - [PlexSourceRequest](docs/PlexSourceRequest.md)
+ - [PlexTokenRedeemRequest](docs/PlexTokenRedeemRequest.md)
+ - [Policy](docs/Policy.md)
+ - [PolicyBinding](docs/PolicyBinding.md)
+ - [PolicyBindingRequest](docs/PolicyBindingRequest.md)
+ - [PolicyEngineMode](docs/PolicyEngineMode.md)
+ - [PolicyTestRequest](docs/PolicyTestRequest.md)
+ - [PolicyTestResult](docs/PolicyTestResult.md)
+ - [Process](docs/Process.md)
+ - [ProcessRequest](docs/ProcessRequest.md)
+ - [Prompt](docs/Prompt.md)
+ - [PromptChallenge](docs/PromptChallenge.md)
+ - [PromptChallengeResponseRequest](docs/PromptChallengeResponseRequest.md)
+ - [PromptChoice](docs/PromptChoice.md)
+ - [PromptRequest](docs/PromptRequest.md)
+ - [PromptStage](docs/PromptStage.md)
+ - [PromptStageRequest](docs/PromptStageRequest.md)
+ - [PromptTypeEnum](docs/PromptTypeEnum.md)
+ - [PropertyMapping](docs/PropertyMapping.md)
+ - [PropertyMappingPreview](docs/PropertyMappingPreview.md)
+ - [PropertyMappingTestRequest](docs/PropertyMappingTestRequest.md)
+ - [PropertyMappingTestResult](docs/PropertyMappingTestResult.md)
+ - [ProtocolEnum](docs/ProtocolEnum.md)
+ - [Provider](docs/Provider.md)
+ - [ProviderEnum](docs/ProviderEnum.md)
+ - [ProviderModelEnum](docs/ProviderModelEnum.md)
+ - [ProviderTypeEnum](docs/ProviderTypeEnum.md)
+ - [ProxyMode](docs/ProxyMode.md)
+ - [ProxyOutpostConfig](docs/ProxyOutpostConfig.md)
+ - [ProxyProvider](docs/ProxyProvider.md)
+ - [ProxyProviderRequest](docs/ProxyProviderRequest.md)
+ - [RACPropertyMapping](docs/RACPropertyMapping.md)
+ - [RACPropertyMappingRequest](docs/RACPropertyMappingRequest.md)
+ - [RACProvider](docs/RACProvider.md)
+ - [RACProviderRequest](docs/RACProviderRequest.md)
+ - [RadiusCheckAccess](docs/RadiusCheckAccess.md)
+ - [RadiusOutpostConfig](docs/RadiusOutpostConfig.md)
+ - [RadiusProvider](docs/RadiusProvider.md)
+ - [RadiusProviderPropertyMapping](docs/RadiusProviderPropertyMapping.md)
+ - [RadiusProviderPropertyMappingRequest](docs/RadiusProviderPropertyMappingRequest.md)
+ - [RadiusProviderRequest](docs/RadiusProviderRequest.md)
+ - [RedirectChallenge](docs/RedirectChallenge.md)
+ - [RedirectChallengeResponseRequest](docs/RedirectChallengeResponseRequest.md)
+ - [RedirectStage](docs/RedirectStage.md)
+ - [RedirectStageModeEnum](docs/RedirectStageModeEnum.md)
+ - [RedirectStageRequest](docs/RedirectStageRequest.md)
+ - [RedirectURI](docs/RedirectURI.md)
+ - [RedirectURIRequest](docs/RedirectURIRequest.md)
+ - [RedirectURITypeEnum](docs/RedirectURITypeEnum.md)
+ - [RelatedGroup](docs/RelatedGroup.md)
+ - [RelatedRule](docs/RelatedRule.md)
+ - [Reputation](docs/Reputation.md)
+ - [ReputationPolicy](docs/ReputationPolicy.md)
+ - [ReputationPolicyRequest](docs/ReputationPolicyRequest.md)
+ - [Review](docs/Review.md)
+ - [ReviewRequest](docs/ReviewRequest.md)
+ - [ReviewerGroup](docs/ReviewerGroup.md)
+ - [ReviewerUser](docs/ReviewerUser.md)
+ - [Role](docs/Role.md)
+ - [RoleAssignedObjectPermission](docs/RoleAssignedObjectPermission.md)
+ - [RoleModelPermission](docs/RoleModelPermission.md)
+ - [RoleObjectPermission](docs/RoleObjectPermission.md)
+ - [RoleRequest](docs/RoleRequest.md)
+ - [SAMLBindingsEnum](docs/SAMLBindingsEnum.md)
+ - [SAMLLogoutMethods](docs/SAMLLogoutMethods.md)
+ - [SAMLMetadata](docs/SAMLMetadata.md)
+ - [SAMLNameIDPolicyEnum](docs/SAMLNameIDPolicyEnum.md)
+ - [SAMLPropertyMapping](docs/SAMLPropertyMapping.md)
+ - [SAMLPropertyMappingRequest](docs/SAMLPropertyMappingRequest.md)
+ - [SAMLProvider](docs/SAMLProvider.md)
+ - [SAMLProviderRequest](docs/SAMLProviderRequest.md)
+ - [SAMLSource](docs/SAMLSource.md)
+ - [SAMLSourcePropertyMapping](docs/SAMLSourcePropertyMapping.md)
+ - [SAMLSourcePropertyMappingRequest](docs/SAMLSourcePropertyMappingRequest.md)
+ - [SAMLSourceRequest](docs/SAMLSourceRequest.md)
+ - [SCIMAuthenticationModeEnum](docs/SCIMAuthenticationModeEnum.md)
+ - [SCIMMapping](docs/SCIMMapping.md)
+ - [SCIMMappingRequest](docs/SCIMMappingRequest.md)
+ - [SCIMProvider](docs/SCIMProvider.md)
+ - [SCIMProviderGroup](docs/SCIMProviderGroup.md)
+ - [SCIMProviderGroupRequest](docs/SCIMProviderGroupRequest.md)
+ - [SCIMProviderRequest](docs/SCIMProviderRequest.md)
+ - [SCIMProviderUser](docs/SCIMProviderUser.md)
+ - [SCIMProviderUserRequest](docs/SCIMProviderUserRequest.md)
+ - [SCIMSource](docs/SCIMSource.md)
+ - [SCIMSourceGroup](docs/SCIMSourceGroup.md)
+ - [SCIMSourceGroupRequest](docs/SCIMSourceGroupRequest.md)
+ - [SCIMSourcePropertyMapping](docs/SCIMSourcePropertyMapping.md)
+ - [SCIMSourcePropertyMappingRequest](docs/SCIMSourcePropertyMappingRequest.md)
+ - [SCIMSourceRequest](docs/SCIMSourceRequest.md)
+ - [SCIMSourceUser](docs/SCIMSourceUser.md)
+ - [SCIMSourceUserRequest](docs/SCIMSourceUserRequest.md)
+ - [SMSDevice](docs/SMSDevice.md)
+ - [SMSDeviceRequest](docs/SMSDeviceRequest.md)
+ - [SSFProvider](docs/SSFProvider.md)
+ - [SSFProviderRequest](docs/SSFProviderRequest.md)
+ - [SSFStream](docs/SSFStream.md)
+ - [SSFStreamStatusEnum](docs/SSFStreamStatusEnum.md)
+ - [Schedule](docs/Schedule.md)
+ - [ScheduleRequest](docs/ScheduleRequest.md)
+ - [ScopeMapping](docs/ScopeMapping.md)
+ - [ScopeMappingRequest](docs/ScopeMappingRequest.md)
+ - [SelectableStage](docs/SelectableStage.md)
+ - [ServiceConnection](docs/ServiceConnection.md)
+ - [ServiceConnectionState](docs/ServiceConnectionState.md)
+ - [SessionEndChallenge](docs/SessionEndChallenge.md)
+ - [SessionUser](docs/SessionUser.md)
+ - [Settings](docs/Settings.md)
+ - [SettingsRequest](docs/SettingsRequest.md)
+ - [SeverityEnum](docs/SeverityEnum.md)
+ - [ShellChallenge](docs/ShellChallenge.md)
+ - [SignatureAlgorithmEnum](docs/SignatureAlgorithmEnum.md)
+ - [Software](docs/Software.md)
+ - [SoftwareRequest](docs/SoftwareRequest.md)
+ - [Source](docs/Source.md)
+ - [SourceStage](docs/SourceStage.md)
+ - [SourceStageRequest](docs/SourceStageRequest.md)
+ - [SourceType](docs/SourceType.md)
+ - [Stage](docs/Stage.md)
+ - [StageModeEnum](docs/StageModeEnum.md)
+ - [StagePrompt](docs/StagePrompt.md)
+ - [StaticDevice](docs/StaticDevice.md)
+ - [StaticDeviceRequest](docs/StaticDeviceRequest.md)
+ - [StaticDeviceToken](docs/StaticDeviceToken.md)
+ - [SubModeEnum](docs/SubModeEnum.md)
+ - [SyncObjectModelEnum](docs/SyncObjectModelEnum.md)
+ - [SyncObjectRequest](docs/SyncObjectRequest.md)
+ - [SyncObjectResult](docs/SyncObjectResult.md)
+ - [SyncOutgoingTriggerModeEnum](docs/SyncOutgoingTriggerModeEnum.md)
+ - [SyncStatus](docs/SyncStatus.md)
+ - [SystemInfo](docs/SystemInfo.md)
+ - [SystemInfoRuntime](docs/SystemInfoRuntime.md)
+ - [TOTPDevice](docs/TOTPDevice.md)
+ - [TOTPDeviceRequest](docs/TOTPDeviceRequest.md)
+ - [Task](docs/Task.md)
+ - [TaskAggregatedStatusEnum](docs/TaskAggregatedStatusEnum.md)
+ - [TaskStatusEnum](docs/TaskStatusEnum.md)
+ - [TelegramAuthRequest](docs/TelegramAuthRequest.md)
+ - [TelegramChallengeResponseRequest](docs/TelegramChallengeResponseRequest.md)
+ - [TelegramLoginChallenge](docs/TelegramLoginChallenge.md)
+ - [TelegramSource](docs/TelegramSource.md)
+ - [TelegramSourcePropertyMapping](docs/TelegramSourcePropertyMapping.md)
+ - [TelegramSourcePropertyMappingRequest](docs/TelegramSourcePropertyMappingRequest.md)
+ - [TelegramSourceRequest](docs/TelegramSourceRequest.md)
+ - [Tenant](docs/Tenant.md)
+ - [TenantAdminGroupRequestRequest](docs/TenantAdminGroupRequestRequest.md)
+ - [TenantRecoveryKeyRequestRequest](docs/TenantRecoveryKeyRequestRequest.md)
+ - [TenantRecoveryKeyResponse](docs/TenantRecoveryKeyResponse.md)
+ - [TenantRequest](docs/TenantRequest.md)
+ - [ThemedUrls](docs/ThemedUrls.md)
+ - [Token](docs/Token.md)
+ - [TokenModel](docs/TokenModel.md)
+ - [TokenRequest](docs/TokenRequest.md)
+ - [TokenSetKeyRequest](docs/TokenSetKeyRequest.md)
+ - [TokenView](docs/TokenView.md)
+ - [TransactionApplicationRequest](docs/TransactionApplicationRequest.md)
+ - [TransactionApplicationResponse](docs/TransactionApplicationResponse.md)
+ - [TransactionPolicyBindingRequest](docs/TransactionPolicyBindingRequest.md)
+ - [TransportModeEnum](docs/TransportModeEnum.md)
+ - [TypeCreate](docs/TypeCreate.md)
+ - [UiThemeEnum](docs/UiThemeEnum.md)
+ - [UniquePasswordPolicy](docs/UniquePasswordPolicy.md)
+ - [UniquePasswordPolicyRequest](docs/UniquePasswordPolicyRequest.md)
+ - [UsageEnum](docs/UsageEnum.md)
+ - [UsedBy](docs/UsedBy.md)
+ - [UsedByActionEnum](docs/UsedByActionEnum.md)
+ - [User](docs/User.md)
+ - [UserAccountLockdownRequest](docs/UserAccountLockdownRequest.md)
+ - [UserAccountRequest](docs/UserAccountRequest.md)
+ - [UserAccountSerializerForRoleRequest](docs/UserAccountSerializerForRoleRequest.md)
+ - [UserAttributeEnum](docs/UserAttributeEnum.md)
+ - [UserConsent](docs/UserConsent.md)
+ - [UserCreationModeEnum](docs/UserCreationModeEnum.md)
+ - [UserDeleteStage](docs/UserDeleteStage.md)
+ - [UserDeleteStageRequest](docs/UserDeleteStageRequest.md)
+ - [UserFieldsEnum](docs/UserFieldsEnum.md)
+ - [UserKerberosSourceConnection](docs/UserKerberosSourceConnection.md)
+ - [UserKerberosSourceConnectionRequest](docs/UserKerberosSourceConnectionRequest.md)
+ - [UserLDAPSourceConnection](docs/UserLDAPSourceConnection.md)
+ - [UserLDAPSourceConnectionRequest](docs/UserLDAPSourceConnectionRequest.md)
+ - [UserLoginChallenge](docs/UserLoginChallenge.md)
+ - [UserLoginChallengeResponseRequest](docs/UserLoginChallengeResponseRequest.md)
+ - [UserLoginStage](docs/UserLoginStage.md)
+ - [UserLoginStageRequest](docs/UserLoginStageRequest.md)
+ - [UserLogoutStage](docs/UserLogoutStage.md)
+ - [UserLogoutStageRequest](docs/UserLogoutStageRequest.md)
+ - [UserMatchingModeEnum](docs/UserMatchingModeEnum.md)
+ - [UserOAuthSourceConnection](docs/UserOAuthSourceConnection.md)
+ - [UserOAuthSourceConnectionRequest](docs/UserOAuthSourceConnectionRequest.md)
+ - [UserPasswordHashSetRequest](docs/UserPasswordHashSetRequest.md)
+ - [UserPasswordSetRequest](docs/UserPasswordSetRequest.md)
+ - [UserPath](docs/UserPath.md)
+ - [UserPlexSourceConnection](docs/UserPlexSourceConnection.md)
+ - [UserPlexSourceConnectionRequest](docs/UserPlexSourceConnectionRequest.md)
+ - [UserRecoveryEmailRequest](docs/UserRecoveryEmailRequest.md)
+ - [UserRecoveryLinkRequest](docs/UserRecoveryLinkRequest.md)
+ - [UserRequest](docs/UserRequest.md)
+ - [UserSAMLSourceConnection](docs/UserSAMLSourceConnection.md)
+ - [UserSAMLSourceConnectionRequest](docs/UserSAMLSourceConnectionRequest.md)
+ - [UserSelf](docs/UserSelf.md)
+ - [UserSelfGroups](docs/UserSelfGroups.md)
+ - [UserSelfRoles](docs/UserSelfRoles.md)
+ - [UserServiceAccountRequest](docs/UserServiceAccountRequest.md)
+ - [UserServiceAccountResponse](docs/UserServiceAccountResponse.md)
+ - [UserSetting](docs/UserSetting.md)
+ - [UserSourceConnection](docs/UserSourceConnection.md)
+ - [UserSourceConnectionRequest](docs/UserSourceConnectionRequest.md)
+ - [UserTelegramSourceConnection](docs/UserTelegramSourceConnection.md)
+ - [UserTelegramSourceConnectionRequest](docs/UserTelegramSourceConnectionRequest.md)
+ - [UserTypeEnum](docs/UserTypeEnum.md)
+ - [UserVerificationEnum](docs/UserVerificationEnum.md)
+ - [UserWriteStage](docs/UserWriteStage.md)
+ - [UserWriteStageRequest](docs/UserWriteStageRequest.md)
+ - [ValidationError](docs/ValidationError.md)
+ - [VendorEnum](docs/VendorEnum.md)
+ - [Version](docs/Version.md)
+ - [VersionHistory](docs/VersionHistory.md)
+ - [WSFederationProvider](docs/WSFederationProvider.md)
+ - [WSFederationProviderRequest](docs/WSFederationProviderRequest.md)
+ - [WebAuthnDevice](docs/WebAuthnDevice.md)
+ - [WebAuthnDeviceRequest](docs/WebAuthnDeviceRequest.md)
+ - [WebAuthnDeviceType](docs/WebAuthnDeviceType.md)
+ - [WebAuthnHintEnum](docs/WebAuthnHintEnum.md)
+ - [Worker](docs/Worker.md)
+
+
+
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+
+### authentik
+
+- **Type**: Bearer authentication
+
+
+## Author
+
+hello@goauthentik.io
+
diff --git a/authentik_client/__init__.py b/authentik_client/__init__.py
new file mode 100644
index 000000000..cb6d930d4
--- /dev/null
+++ b/authentik_client/__init__.py
@@ -0,0 +1,1863 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+__version__ = "2026.5.0-rc1"
+
+# Define package exports
+__all__ = [
+ "AdminApi",
+ "AuthenticatorsApi",
+ "CoreApi",
+ "CryptoApi",
+ "EndpointsApi",
+ "EnterpriseApi",
+ "EventsApi",
+ "FlowsApi",
+ "LifecycleApi",
+ "ManagedApi",
+ "Oauth2Api",
+ "OutpostsApi",
+ "PoliciesApi",
+ "PropertymappingsApi",
+ "ProvidersApi",
+ "RacApi",
+ "RbacApi",
+ "ReportsApi",
+ "RootApi",
+ "SchemaApi",
+ "SourcesApi",
+ "SsfApi",
+ "StagesApi",
+ "TasksApi",
+ "TenantsApi",
+ "ApiResponse",
+ "ApiClient",
+ "Configuration",
+ "OpenApiException",
+ "ApiTypeError",
+ "ApiValueError",
+ "ApiKeyError",
+ "ApiAttributeError",
+ "ApiException",
+ "AccessDeniedChallenge",
+ "AccountLockdownStage",
+ "AccountLockdownStageRequest",
+ "AgentAuthenticationResponse",
+ "AgentConfig",
+ "AgentConnector",
+ "AgentConnectorRequest",
+ "AgentPSSODeviceRegistrationRequest",
+ "AgentPSSODeviceRegistrationResponse",
+ "AgentPSSOUserRegistrationRequest",
+ "AgentTokenResponse",
+ "AlgEnum",
+ "App",
+ "AppEnum",
+ "AppleChallengeResponseRequest",
+ "AppleIndependentSecureEnclave",
+ "AppleIndependentSecureEnclaveRequest",
+ "AppleLoginChallenge",
+ "Application",
+ "ApplicationEntitlement",
+ "ApplicationEntitlementRequest",
+ "ApplicationRequest",
+ "AuthTypeEnum",
+ "AuthenticatedSession",
+ "AuthenticatedSessionAsn",
+ "AuthenticatedSessionGeoIp",
+ "AuthenticatedSessionUserAgent",
+ "AuthenticatedSessionUserAgentDevice",
+ "AuthenticatedSessionUserAgentOs",
+ "AuthenticatedSessionUserAgentUserAgent",
+ "AuthenticationEnum",
+ "AuthenticatorAttachmentEnum",
+ "AuthenticatorDuoChallenge",
+ "AuthenticatorDuoChallengeResponseRequest",
+ "AuthenticatorDuoStage",
+ "AuthenticatorDuoStageDeviceImportResponse",
+ "AuthenticatorDuoStageManualDeviceImportRequest",
+ "AuthenticatorDuoStageRequest",
+ "AuthenticatorEmailChallenge",
+ "AuthenticatorEmailChallengeResponseRequest",
+ "AuthenticatorEmailStage",
+ "AuthenticatorEmailStageRequest",
+ "AuthenticatorEndpointGDTCStage",
+ "AuthenticatorEndpointGDTCStageRequest",
+ "AuthenticatorSMSChallenge",
+ "AuthenticatorSMSChallengeResponseRequest",
+ "AuthenticatorSMSStage",
+ "AuthenticatorSMSStageRequest",
+ "AuthenticatorStaticChallenge",
+ "AuthenticatorStaticChallengeResponseRequest",
+ "AuthenticatorStaticStage",
+ "AuthenticatorStaticStageRequest",
+ "AuthenticatorTOTPChallenge",
+ "AuthenticatorTOTPChallengeResponseRequest",
+ "AuthenticatorTOTPStage",
+ "AuthenticatorTOTPStageRequest",
+ "AuthenticatorValidateStage",
+ "AuthenticatorValidateStageRequest",
+ "AuthenticatorValidationChallenge",
+ "AuthenticatorValidationChallengeResponseRequest",
+ "AuthenticatorWebAuthnChallenge",
+ "AuthenticatorWebAuthnChallengeResponseRequest",
+ "AuthenticatorWebAuthnStage",
+ "AuthenticatorWebAuthnStageRequest",
+ "AuthorizationCodeAuthMethodEnum",
+ "AutoSubmitChallengeResponseRequest",
+ "AutosubmitChallenge",
+ "BackendsEnum",
+ "BindingTypeEnum",
+ "BlueprintFile",
+ "BlueprintImportResult",
+ "BlueprintInstance",
+ "BlueprintInstanceRequest",
+ "BlueprintInstanceStatusEnum",
+ "Brand",
+ "BrandRequest",
+ "BulkDeleteSessionResponse",
+ "Cache",
+ "CapabilitiesEnum",
+ "CaptchaChallenge",
+ "CaptchaChallengeResponseRequest",
+ "CaptchaStage",
+ "CaptchaStageRequest",
+ "CertAttributeEnum",
+ "CertificateData",
+ "CertificateGenerationRequest",
+ "CertificateKeyPair",
+ "CertificateKeyPairKeyTypeEnum",
+ "CertificateKeyPairRequest",
+ "ChallengeTypes",
+ "ClientTypeEnum",
+ "CompatibilityModeEnum",
+ "Config",
+ "ConnectionToken",
+ "ConnectionTokenRequest",
+ "Connector",
+ "ConsentChallenge",
+ "ConsentChallengeResponseRequest",
+ "ConsentModeEnum",
+ "ConsentPermission",
+ "ConsentStage",
+ "ConsentStageRequest",
+ "ContentType",
+ "ContentTypeEnum",
+ "ContextualFlowInfo",
+ "ContextualFlowInfoLayoutEnum",
+ "CountryCodeEnum",
+ "CurrentBrand",
+ "CurrentBrandFlags",
+ "DataExport",
+ "DeliveryMethodEnum",
+ "DeniedActionEnum",
+ "DenyStage",
+ "DenyStageRequest",
+ "DetailedCountry",
+ "Device",
+ "DeviceAccessGroup",
+ "DeviceAccessGroupRequest",
+ "DeviceChallenge",
+ "DeviceChallengeRequest",
+ "DeviceClassesEnum",
+ "DeviceConnection",
+ "DeviceFactSnapshot",
+ "DeviceFacts",
+ "DeviceFactsOSFamily",
+ "DeviceFactsRequest",
+ "DeviceGroup",
+ "DeviceGroupRequest",
+ "DeviceSummary",
+ "DeviceUser",
+ "DeviceUserBinding",
+ "DeviceUserBindingRequest",
+ "DeviceUserRequest",
+ "DigestAlgorithmEnum",
+ "DigitsEnum",
+ "Disk",
+ "DiskRequest",
+ "DockerServiceConnection",
+ "DockerServiceConnectionRequest",
+ "Domain",
+ "DomainRequest",
+ "DummyChallenge",
+ "DummyChallengeResponseRequest",
+ "DummyPolicy",
+ "DummyPolicyRequest",
+ "DummyStage",
+ "DummyStageRequest",
+ "DuoDevice",
+ "DuoDeviceEnrollmentStatus",
+ "DuoDeviceRequest",
+ "DuoResponseEnum",
+ "EmailChallenge",
+ "EmailChallengeResponseRequest",
+ "EmailDevice",
+ "EmailDeviceRequest",
+ "EmailStage",
+ "EmailStageRequest",
+ "Endpoint",
+ "EndpointAgentChallenge",
+ "EndpointAgentChallengeResponseRequest",
+ "EndpointAuthModeEnum",
+ "EndpointDevice",
+ "EndpointDeviceDetails",
+ "EndpointDeviceRequest",
+ "EndpointRequest",
+ "EndpointStage",
+ "EndpointStageRequest",
+ "EnrollRequest",
+ "EnrollmentToken",
+ "EnrollmentTokenRequest",
+ "ErrorDetail",
+ "ErrorReportingConfig",
+ "Event",
+ "EventActions",
+ "EventMatcherPolicy",
+ "EventMatcherPolicyRequest",
+ "EventRequest",
+ "EventStats",
+ "EventTopPerUser",
+ "EventVolume",
+ "EventsRequestedEnum",
+ "ExpiringBaseGrantModel",
+ "ExpressionPolicy",
+ "ExpressionPolicyRequest",
+ "ExtraRoleObjectPermission",
+ "FileList",
+ "FleetConnector",
+ "FleetConnectorRequest",
+ "Flow",
+ "FlowChallengeResponseRequest",
+ "FlowDesignationEnum",
+ "FlowDiagram",
+ "FlowErrorChallenge",
+ "FlowInspection",
+ "FlowInspectorPlan",
+ "FlowLayoutEnum",
+ "FlowRequest",
+ "FlowSet",
+ "FlowStageBinding",
+ "FlowStageBindingRequest",
+ "FooterLink",
+ "ForceBindingEnum",
+ "FormatEnum",
+ "FrameChallenge",
+ "FrameChallengeResponseRequest",
+ "GenericError",
+ "GeoIPPolicy",
+ "GeoIPPolicyCountriesObjInner",
+ "GeoIPPolicyRequest",
+ "GeoipBindingEnum",
+ "GlobalTaskStatus",
+ "GoogleChromeConnector",
+ "GoogleChromeConnectorRequest",
+ "GoogleEndpointDevice",
+ "GoogleEndpointDeviceRequest",
+ "GoogleWorkspaceProvider",
+ "GoogleWorkspaceProviderGroup",
+ "GoogleWorkspaceProviderGroupRequest",
+ "GoogleWorkspaceProviderMapping",
+ "GoogleWorkspaceProviderMappingRequest",
+ "GoogleWorkspaceProviderRequest",
+ "GoogleWorkspaceProviderUser",
+ "GoogleWorkspaceProviderUserRequest",
+ "GrantTypesEnum",
+ "Group",
+ "GroupKerberosSourceConnection",
+ "GroupKerberosSourceConnectionRequest",
+ "GroupLDAPSourceConnection",
+ "GroupLDAPSourceConnectionRequest",
+ "GroupMatchingModeEnum",
+ "GroupOAuthSourceConnection",
+ "GroupOAuthSourceConnectionRequest",
+ "GroupPlexSourceConnection",
+ "GroupPlexSourceConnectionRequest",
+ "GroupRequest",
+ "GroupSAMLSourceConnection",
+ "GroupSAMLSourceConnectionRequest",
+ "GroupSourceConnection",
+ "GroupSourceConnectionRequest",
+ "GroupTelegramSourceConnection",
+ "GroupTelegramSourceConnectionRequest",
+ "Hardware",
+ "HardwareRequest",
+ "IdentificationChallenge",
+ "IdentificationChallengeResponseRequest",
+ "IdentificationStage",
+ "IdentificationStageRequest",
+ "IframeLogoutChallenge",
+ "IframeLogoutChallengeResponseRequest",
+ "ImpersonationRequest",
+ "InitialPermissions",
+ "InitialPermissionsRequest",
+ "InstallID",
+ "IntentEnum",
+ "InvalidResponseActionEnum",
+ "Invitation",
+ "InvitationRequest",
+ "InvitationSendEmailRequest",
+ "InvitationStage",
+ "InvitationStageRequest",
+ "IssuerModeEnum",
+ "KadminTypeEnum",
+ "KerberosSource",
+ "KerberosSourcePropertyMapping",
+ "KerberosSourcePropertyMappingRequest",
+ "KerberosSourceRequest",
+ "KeyTypeEnum",
+ "KubernetesServiceConnection",
+ "KubernetesServiceConnectionRequest",
+ "LDAPAPIAccessMode",
+ "LDAPCheckAccess",
+ "LDAPDebug",
+ "LDAPOutpostConfig",
+ "LDAPProvider",
+ "LDAPProviderRequest",
+ "LDAPSource",
+ "LDAPSourcePropertyMapping",
+ "LDAPSourcePropertyMappingRequest",
+ "LDAPSourceRequest",
+ "LangEnum",
+ "LastTaskStatusEnum",
+ "License",
+ "LicenseFlagsEnum",
+ "LicenseForecast",
+ "LicenseRequest",
+ "LicenseStatusEnum",
+ "LicenseSummary",
+ "LicenseSummaryStatusEnum",
+ "LifecycleIteration",
+ "LifecycleIterationRequest",
+ "LifecycleIterationStateEnum",
+ "LifecycleRule",
+ "LifecycleRuleRequest",
+ "Link",
+ "LogEvent",
+ "LogLevelEnum",
+ "LoginChallengeTypes",
+ "LoginSource",
+ "LogoutURL",
+ "MDMConfigRequest",
+ "MDMConfigResponse",
+ "MatchingModeEnum",
+ "Metadata",
+ "MicrosoftEntraProvider",
+ "MicrosoftEntraProviderGroup",
+ "MicrosoftEntraProviderGroupRequest",
+ "MicrosoftEntraProviderMapping",
+ "MicrosoftEntraProviderMappingRequest",
+ "MicrosoftEntraProviderRequest",
+ "MicrosoftEntraProviderUser",
+ "MicrosoftEntraProviderUserRequest",
+ "ModelEnum",
+ "ModelRequest",
+ "MutualTLSStage",
+ "MutualTLSStageRequest",
+ "NativeLogoutChallenge",
+ "NativeLogoutChallengeResponseRequest",
+ "Network",
+ "NetworkBindingEnum",
+ "NetworkInterface",
+ "NetworkInterfaceRequest",
+ "NetworkRequest",
+ "NotConfiguredActionEnum",
+ "Notification",
+ "NotificationRequest",
+ "NotificationRule",
+ "NotificationRuleRequest",
+ "NotificationTransport",
+ "NotificationTransportRequest",
+ "NotificationTransportTest",
+ "NotificationWebhookMapping",
+ "NotificationWebhookMappingRequest",
+ "OAuth2Provider",
+ "OAuth2ProviderLogoutMethodEnum",
+ "OAuth2ProviderRequest",
+ "OAuth2ProviderSetupURLs",
+ "OAuthDeviceCodeChallenge",
+ "OAuthDeviceCodeChallengeResponseRequest",
+ "OAuthDeviceCodeFinishChallenge",
+ "OAuthDeviceCodeFinishChallengeResponseRequest",
+ "OAuthSource",
+ "OAuthSourcePropertyMapping",
+ "OAuthSourcePropertyMappingRequest",
+ "OAuthSourceRequest",
+ "OpenIDConnectConfiguration",
+ "OperatingSystem",
+ "OperatingSystemRequest",
+ "OutgoingSyncDeleteAction",
+ "Outpost",
+ "OutpostDefaultConfig",
+ "OutpostHealth",
+ "OutpostRequest",
+ "OutpostTypeEnum",
+ "PKCEMethodEnum",
+ "PaginatedAccountLockdownStageList",
+ "PaginatedAgentConnectorList",
+ "PaginatedAppleIndependentSecureEnclaveList",
+ "PaginatedApplicationEntitlementList",
+ "PaginatedApplicationList",
+ "PaginatedAuthenticatedSessionList",
+ "PaginatedAuthenticatorDuoStageList",
+ "PaginatedAuthenticatorEmailStageList",
+ "PaginatedAuthenticatorEndpointGDTCStageList",
+ "PaginatedAuthenticatorSMSStageList",
+ "PaginatedAuthenticatorStaticStageList",
+ "PaginatedAuthenticatorTOTPStageList",
+ "PaginatedAuthenticatorValidateStageList",
+ "PaginatedAuthenticatorWebAuthnStageList",
+ "PaginatedBlueprintInstanceList",
+ "PaginatedBrandList",
+ "PaginatedCaptchaStageList",
+ "PaginatedCertificateKeyPairList",
+ "PaginatedConnectionTokenList",
+ "PaginatedConnectorList",
+ "PaginatedConsentStageList",
+ "PaginatedDataExportList",
+ "PaginatedDenyStageList",
+ "PaginatedDeviceAccessGroupList",
+ "PaginatedDeviceUserBindingList",
+ "PaginatedDockerServiceConnectionList",
+ "PaginatedDomainList",
+ "PaginatedDummyPolicyList",
+ "PaginatedDummyStageList",
+ "PaginatedDuoDeviceList",
+ "PaginatedEmailDeviceList",
+ "PaginatedEmailStageList",
+ "PaginatedEndpointDeviceList",
+ "PaginatedEndpointList",
+ "PaginatedEndpointStageList",
+ "PaginatedEnrollmentTokenList",
+ "PaginatedEventList",
+ "PaginatedEventMatcherPolicyList",
+ "PaginatedExpiringBaseGrantModelList",
+ "PaginatedExpressionPolicyList",
+ "PaginatedExtraRoleObjectPermissionList",
+ "PaginatedFleetConnectorList",
+ "PaginatedFlowList",
+ "PaginatedFlowStageBindingList",
+ "PaginatedGeoIPPolicyList",
+ "PaginatedGoogleChromeConnectorList",
+ "PaginatedGoogleEndpointDeviceList",
+ "PaginatedGoogleWorkspaceProviderGroupList",
+ "PaginatedGoogleWorkspaceProviderList",
+ "PaginatedGoogleWorkspaceProviderMappingList",
+ "PaginatedGoogleWorkspaceProviderUserList",
+ "PaginatedGroupKerberosSourceConnectionList",
+ "PaginatedGroupLDAPSourceConnectionList",
+ "PaginatedGroupList",
+ "PaginatedGroupOAuthSourceConnectionList",
+ "PaginatedGroupPlexSourceConnectionList",
+ "PaginatedGroupSAMLSourceConnectionList",
+ "PaginatedGroupSourceConnectionList",
+ "PaginatedGroupTelegramSourceConnectionList",
+ "PaginatedIdentificationStageList",
+ "PaginatedInitialPermissionsList",
+ "PaginatedInvitationList",
+ "PaginatedInvitationStageList",
+ "PaginatedKerberosSourceList",
+ "PaginatedKerberosSourcePropertyMappingList",
+ "PaginatedKubernetesServiceConnectionList",
+ "PaginatedLDAPOutpostConfigList",
+ "PaginatedLDAPProviderList",
+ "PaginatedLDAPSourceList",
+ "PaginatedLDAPSourcePropertyMappingList",
+ "PaginatedLicenseList",
+ "PaginatedLifecycleIterationList",
+ "PaginatedLifecycleRuleList",
+ "PaginatedMicrosoftEntraProviderGroupList",
+ "PaginatedMicrosoftEntraProviderList",
+ "PaginatedMicrosoftEntraProviderMappingList",
+ "PaginatedMicrosoftEntraProviderUserList",
+ "PaginatedMutualTLSStageList",
+ "PaginatedNotificationList",
+ "PaginatedNotificationRuleList",
+ "PaginatedNotificationTransportList",
+ "PaginatedNotificationWebhookMappingList",
+ "PaginatedOAuth2ProviderList",
+ "PaginatedOAuthSourceList",
+ "PaginatedOAuthSourcePropertyMappingList",
+ "PaginatedOutpostList",
+ "PaginatedPasswordExpiryPolicyList",
+ "PaginatedPasswordPolicyList",
+ "PaginatedPasswordStageList",
+ "PaginatedPermissionList",
+ "PaginatedPlexSourceList",
+ "PaginatedPlexSourcePropertyMappingList",
+ "PaginatedPolicyBindingList",
+ "PaginatedPolicyList",
+ "PaginatedPromptList",
+ "PaginatedPromptStageList",
+ "PaginatedPropertyMappingList",
+ "PaginatedProviderList",
+ "PaginatedProxyOutpostConfigList",
+ "PaginatedProxyProviderList",
+ "PaginatedRACPropertyMappingList",
+ "PaginatedRACProviderList",
+ "PaginatedRadiusOutpostConfigList",
+ "PaginatedRadiusProviderList",
+ "PaginatedRadiusProviderPropertyMappingList",
+ "PaginatedRedirectStageList",
+ "PaginatedReputationList",
+ "PaginatedReputationPolicyList",
+ "PaginatedRoleAssignedObjectPermissionList",
+ "PaginatedRoleList",
+ "PaginatedSAMLPropertyMappingList",
+ "PaginatedSAMLProviderList",
+ "PaginatedSAMLSourceList",
+ "PaginatedSAMLSourcePropertyMappingList",
+ "PaginatedSCIMMappingList",
+ "PaginatedSCIMProviderGroupList",
+ "PaginatedSCIMProviderList",
+ "PaginatedSCIMProviderUserList",
+ "PaginatedSCIMSourceGroupList",
+ "PaginatedSCIMSourceList",
+ "PaginatedSCIMSourcePropertyMappingList",
+ "PaginatedSCIMSourceUserList",
+ "PaginatedSMSDeviceList",
+ "PaginatedSSFProviderList",
+ "PaginatedSSFStreamList",
+ "PaginatedScheduleList",
+ "PaginatedScopeMappingList",
+ "PaginatedServiceConnectionList",
+ "PaginatedSourceList",
+ "PaginatedSourceStageList",
+ "PaginatedStageList",
+ "PaginatedStaticDeviceList",
+ "PaginatedTOTPDeviceList",
+ "PaginatedTaskList",
+ "PaginatedTelegramSourceList",
+ "PaginatedTelegramSourcePropertyMappingList",
+ "PaginatedTenantList",
+ "PaginatedTokenList",
+ "PaginatedTokenModelList",
+ "PaginatedUniquePasswordPolicyList",
+ "PaginatedUserConsentList",
+ "PaginatedUserDeleteStageList",
+ "PaginatedUserKerberosSourceConnectionList",
+ "PaginatedUserLDAPSourceConnectionList",
+ "PaginatedUserList",
+ "PaginatedUserLoginStageList",
+ "PaginatedUserLogoutStageList",
+ "PaginatedUserOAuthSourceConnectionList",
+ "PaginatedUserPlexSourceConnectionList",
+ "PaginatedUserSAMLSourceConnectionList",
+ "PaginatedUserSourceConnectionList",
+ "PaginatedUserTelegramSourceConnectionList",
+ "PaginatedUserWriteStageList",
+ "PaginatedWSFederationProviderList",
+ "PaginatedWebAuthnDeviceList",
+ "PaginatedWebAuthnDeviceTypeList",
+ "Pagination",
+ "PartialGroup",
+ "PartialUser",
+ "PasswordChallenge",
+ "PasswordChallengeResponseRequest",
+ "PasswordExpiryPolicy",
+ "PasswordExpiryPolicyRequest",
+ "PasswordPolicy",
+ "PasswordPolicyRequest",
+ "PasswordStage",
+ "PasswordStageRequest",
+ "PatchedAccountLockdownStageRequest",
+ "PatchedAgentConnectorRequest",
+ "PatchedAppleIndependentSecureEnclaveRequest",
+ "PatchedApplicationEntitlementRequest",
+ "PatchedApplicationRequest",
+ "PatchedAuthenticatorDuoStageRequest",
+ "PatchedAuthenticatorEmailStageRequest",
+ "PatchedAuthenticatorEndpointGDTCStageRequest",
+ "PatchedAuthenticatorSMSStageRequest",
+ "PatchedAuthenticatorStaticStageRequest",
+ "PatchedAuthenticatorTOTPStageRequest",
+ "PatchedAuthenticatorValidateStageRequest",
+ "PatchedAuthenticatorWebAuthnStageRequest",
+ "PatchedBlueprintInstanceRequest",
+ "PatchedBrandRequest",
+ "PatchedCaptchaStageRequest",
+ "PatchedCertificateKeyPairRequest",
+ "PatchedConnectionTokenRequest",
+ "PatchedConsentStageRequest",
+ "PatchedDenyStageRequest",
+ "PatchedDeviceAccessGroupRequest",
+ "PatchedDeviceUserBindingRequest",
+ "PatchedDockerServiceConnectionRequest",
+ "PatchedDomainRequest",
+ "PatchedDummyPolicyRequest",
+ "PatchedDummyStageRequest",
+ "PatchedDuoDeviceRequest",
+ "PatchedEmailDeviceRequest",
+ "PatchedEmailStageRequest",
+ "PatchedEndpointDeviceRequest",
+ "PatchedEndpointRequest",
+ "PatchedEndpointStageRequest",
+ "PatchedEnrollmentTokenRequest",
+ "PatchedEventMatcherPolicyRequest",
+ "PatchedEventRequest",
+ "PatchedExpressionPolicyRequest",
+ "PatchedFleetConnectorRequest",
+ "PatchedFlowRequest",
+ "PatchedFlowStageBindingRequest",
+ "PatchedGeoIPPolicyRequest",
+ "PatchedGoogleChromeConnectorRequest",
+ "PatchedGoogleEndpointDeviceRequest",
+ "PatchedGoogleWorkspaceProviderMappingRequest",
+ "PatchedGoogleWorkspaceProviderRequest",
+ "PatchedGroupKerberosSourceConnectionRequest",
+ "PatchedGroupLDAPSourceConnectionRequest",
+ "PatchedGroupOAuthSourceConnectionRequest",
+ "PatchedGroupPlexSourceConnectionRequest",
+ "PatchedGroupRequest",
+ "PatchedGroupSAMLSourceConnectionRequest",
+ "PatchedGroupSourceConnectionRequest",
+ "PatchedGroupTelegramSourceConnectionRequest",
+ "PatchedIdentificationStageRequest",
+ "PatchedInitialPermissionsRequest",
+ "PatchedInvitationRequest",
+ "PatchedInvitationStageRequest",
+ "PatchedKerberosSourcePropertyMappingRequest",
+ "PatchedKerberosSourceRequest",
+ "PatchedKubernetesServiceConnectionRequest",
+ "PatchedLDAPProviderRequest",
+ "PatchedLDAPSourcePropertyMappingRequest",
+ "PatchedLDAPSourceRequest",
+ "PatchedLicenseRequest",
+ "PatchedLifecycleRuleRequest",
+ "PatchedMicrosoftEntraProviderMappingRequest",
+ "PatchedMicrosoftEntraProviderRequest",
+ "PatchedMutualTLSStageRequest",
+ "PatchedNotificationRequest",
+ "PatchedNotificationRuleRequest",
+ "PatchedNotificationTransportRequest",
+ "PatchedNotificationWebhookMappingRequest",
+ "PatchedOAuth2ProviderRequest",
+ "PatchedOAuthSourcePropertyMappingRequest",
+ "PatchedOAuthSourceRequest",
+ "PatchedOutpostRequest",
+ "PatchedPasswordExpiryPolicyRequest",
+ "PatchedPasswordPolicyRequest",
+ "PatchedPasswordStageRequest",
+ "PatchedPermissionAssignRequest",
+ "PatchedPlexSourcePropertyMappingRequest",
+ "PatchedPlexSourceRequest",
+ "PatchedPolicyBindingRequest",
+ "PatchedPromptRequest",
+ "PatchedPromptStageRequest",
+ "PatchedProxyProviderRequest",
+ "PatchedRACPropertyMappingRequest",
+ "PatchedRACProviderRequest",
+ "PatchedRadiusProviderPropertyMappingRequest",
+ "PatchedRadiusProviderRequest",
+ "PatchedRedirectStageRequest",
+ "PatchedReputationPolicyRequest",
+ "PatchedRoleRequest",
+ "PatchedSAMLPropertyMappingRequest",
+ "PatchedSAMLProviderRequest",
+ "PatchedSAMLSourcePropertyMappingRequest",
+ "PatchedSAMLSourceRequest",
+ "PatchedSCIMMappingRequest",
+ "PatchedSCIMProviderRequest",
+ "PatchedSCIMSourceGroupRequest",
+ "PatchedSCIMSourcePropertyMappingRequest",
+ "PatchedSCIMSourceRequest",
+ "PatchedSCIMSourceUserRequest",
+ "PatchedSMSDeviceRequest",
+ "PatchedSSFProviderRequest",
+ "PatchedScheduleRequest",
+ "PatchedScopeMappingRequest",
+ "PatchedSettingsRequest",
+ "PatchedSettingsRequestFlags",
+ "PatchedSourceStageRequest",
+ "PatchedStaticDeviceRequest",
+ "PatchedTOTPDeviceRequest",
+ "PatchedTelegramSourcePropertyMappingRequest",
+ "PatchedTelegramSourceRequest",
+ "PatchedTenantRequest",
+ "PatchedTokenRequest",
+ "PatchedUniquePasswordPolicyRequest",
+ "PatchedUserDeleteStageRequest",
+ "PatchedUserKerberosSourceConnectionRequest",
+ "PatchedUserLDAPSourceConnectionRequest",
+ "PatchedUserLoginStageRequest",
+ "PatchedUserLogoutStageRequest",
+ "PatchedUserOAuthSourceConnectionRequest",
+ "PatchedUserPlexSourceConnectionRequest",
+ "PatchedUserRequest",
+ "PatchedUserSAMLSourceConnectionRequest",
+ "PatchedUserSourceConnectionRequest",
+ "PatchedUserTelegramSourceConnectionRequest",
+ "PatchedUserWriteStageRequest",
+ "PatchedWSFederationProviderRequest",
+ "PatchedWebAuthnDeviceRequest",
+ "Permission",
+ "PermissionAssignRequest",
+ "PermissionAssignResult",
+ "PlexAuthenticationChallenge",
+ "PlexAuthenticationChallengeResponseRequest",
+ "PlexSource",
+ "PlexSourcePropertyMapping",
+ "PlexSourcePropertyMappingRequest",
+ "PlexSourceRequest",
+ "PlexTokenRedeemRequest",
+ "Policy",
+ "PolicyBinding",
+ "PolicyBindingRequest",
+ "PolicyEngineMode",
+ "PolicyTestRequest",
+ "PolicyTestResult",
+ "Process",
+ "ProcessRequest",
+ "Prompt",
+ "PromptChallenge",
+ "PromptChallengeResponseRequest",
+ "PromptChoice",
+ "PromptRequest",
+ "PromptStage",
+ "PromptStageRequest",
+ "PromptTypeEnum",
+ "PropertyMapping",
+ "PropertyMappingPreview",
+ "PropertyMappingTestRequest",
+ "PropertyMappingTestResult",
+ "ProtocolEnum",
+ "Provider",
+ "ProviderEnum",
+ "ProviderModelEnum",
+ "ProviderTypeEnum",
+ "ProxyMode",
+ "ProxyOutpostConfig",
+ "ProxyProvider",
+ "ProxyProviderRequest",
+ "RACPropertyMapping",
+ "RACPropertyMappingRequest",
+ "RACProvider",
+ "RACProviderRequest",
+ "RadiusCheckAccess",
+ "RadiusOutpostConfig",
+ "RadiusProvider",
+ "RadiusProviderPropertyMapping",
+ "RadiusProviderPropertyMappingRequest",
+ "RadiusProviderRequest",
+ "RedirectChallenge",
+ "RedirectChallengeResponseRequest",
+ "RedirectStage",
+ "RedirectStageModeEnum",
+ "RedirectStageRequest",
+ "RedirectURI",
+ "RedirectURIRequest",
+ "RedirectURITypeEnum",
+ "RelatedGroup",
+ "RelatedRule",
+ "Reputation",
+ "ReputationPolicy",
+ "ReputationPolicyRequest",
+ "Review",
+ "ReviewRequest",
+ "ReviewerGroup",
+ "ReviewerUser",
+ "Role",
+ "RoleAssignedObjectPermission",
+ "RoleModelPermission",
+ "RoleObjectPermission",
+ "RoleRequest",
+ "SAMLBindingsEnum",
+ "SAMLLogoutMethods",
+ "SAMLMetadata",
+ "SAMLNameIDPolicyEnum",
+ "SAMLPropertyMapping",
+ "SAMLPropertyMappingRequest",
+ "SAMLProvider",
+ "SAMLProviderRequest",
+ "SAMLSource",
+ "SAMLSourcePropertyMapping",
+ "SAMLSourcePropertyMappingRequest",
+ "SAMLSourceRequest",
+ "SCIMAuthenticationModeEnum",
+ "SCIMMapping",
+ "SCIMMappingRequest",
+ "SCIMProvider",
+ "SCIMProviderGroup",
+ "SCIMProviderGroupRequest",
+ "SCIMProviderRequest",
+ "SCIMProviderUser",
+ "SCIMProviderUserRequest",
+ "SCIMSource",
+ "SCIMSourceGroup",
+ "SCIMSourceGroupRequest",
+ "SCIMSourcePropertyMapping",
+ "SCIMSourcePropertyMappingRequest",
+ "SCIMSourceRequest",
+ "SCIMSourceUser",
+ "SCIMSourceUserRequest",
+ "SMSDevice",
+ "SMSDeviceRequest",
+ "SSFProvider",
+ "SSFProviderRequest",
+ "SSFStream",
+ "SSFStreamStatusEnum",
+ "Schedule",
+ "ScheduleRequest",
+ "ScopeMapping",
+ "ScopeMappingRequest",
+ "SelectableStage",
+ "ServiceConnection",
+ "ServiceConnectionState",
+ "SessionEndChallenge",
+ "SessionUser",
+ "Settings",
+ "SettingsRequest",
+ "SeverityEnum",
+ "ShellChallenge",
+ "SignatureAlgorithmEnum",
+ "Software",
+ "SoftwareRequest",
+ "Source",
+ "SourceStage",
+ "SourceStageRequest",
+ "SourceType",
+ "Stage",
+ "StageModeEnum",
+ "StagePrompt",
+ "StaticDevice",
+ "StaticDeviceRequest",
+ "StaticDeviceToken",
+ "SubModeEnum",
+ "SyncObjectModelEnum",
+ "SyncObjectRequest",
+ "SyncObjectResult",
+ "SyncOutgoingTriggerModeEnum",
+ "SyncStatus",
+ "SystemInfo",
+ "SystemInfoRuntime",
+ "TOTPDevice",
+ "TOTPDeviceRequest",
+ "Task",
+ "TaskAggregatedStatusEnum",
+ "TaskStatusEnum",
+ "TelegramAuthRequest",
+ "TelegramChallengeResponseRequest",
+ "TelegramLoginChallenge",
+ "TelegramSource",
+ "TelegramSourcePropertyMapping",
+ "TelegramSourcePropertyMappingRequest",
+ "TelegramSourceRequest",
+ "Tenant",
+ "TenantAdminGroupRequestRequest",
+ "TenantRecoveryKeyRequestRequest",
+ "TenantRecoveryKeyResponse",
+ "TenantRequest",
+ "ThemedUrls",
+ "Token",
+ "TokenModel",
+ "TokenRequest",
+ "TokenSetKeyRequest",
+ "TokenView",
+ "TransactionApplicationRequest",
+ "TransactionApplicationResponse",
+ "TransactionPolicyBindingRequest",
+ "TransportModeEnum",
+ "TypeCreate",
+ "UiThemeEnum",
+ "UniquePasswordPolicy",
+ "UniquePasswordPolicyRequest",
+ "UsageEnum",
+ "UsedBy",
+ "UsedByActionEnum",
+ "User",
+ "UserAccountLockdownRequest",
+ "UserAccountRequest",
+ "UserAccountSerializerForRoleRequest",
+ "UserAttributeEnum",
+ "UserConsent",
+ "UserCreationModeEnum",
+ "UserDeleteStage",
+ "UserDeleteStageRequest",
+ "UserFieldsEnum",
+ "UserKerberosSourceConnection",
+ "UserKerberosSourceConnectionRequest",
+ "UserLDAPSourceConnection",
+ "UserLDAPSourceConnectionRequest",
+ "UserLoginChallenge",
+ "UserLoginChallengeResponseRequest",
+ "UserLoginStage",
+ "UserLoginStageRequest",
+ "UserLogoutStage",
+ "UserLogoutStageRequest",
+ "UserMatchingModeEnum",
+ "UserOAuthSourceConnection",
+ "UserOAuthSourceConnectionRequest",
+ "UserPasswordHashSetRequest",
+ "UserPasswordSetRequest",
+ "UserPath",
+ "UserPlexSourceConnection",
+ "UserPlexSourceConnectionRequest",
+ "UserRecoveryEmailRequest",
+ "UserRecoveryLinkRequest",
+ "UserRequest",
+ "UserSAMLSourceConnection",
+ "UserSAMLSourceConnectionRequest",
+ "UserSelf",
+ "UserSelfGroups",
+ "UserSelfRoles",
+ "UserServiceAccountRequest",
+ "UserServiceAccountResponse",
+ "UserSetting",
+ "UserSourceConnection",
+ "UserSourceConnectionRequest",
+ "UserTelegramSourceConnection",
+ "UserTelegramSourceConnectionRequest",
+ "UserTypeEnum",
+ "UserVerificationEnum",
+ "UserWriteStage",
+ "UserWriteStageRequest",
+ "ValidationError",
+ "VendorEnum",
+ "Version",
+ "VersionHistory",
+ "WSFederationProvider",
+ "WSFederationProviderRequest",
+ "WebAuthnDevice",
+ "WebAuthnDeviceRequest",
+ "WebAuthnDeviceType",
+ "WebAuthnHintEnum",
+ "Worker",
+]
+
+# import apis into sdk package
+from authentik_client.api.admin_api import AdminApi as AdminApi
+from authentik_client.api.authenticators_api import AuthenticatorsApi as AuthenticatorsApi
+from authentik_client.api.core_api import CoreApi as CoreApi
+from authentik_client.api.crypto_api import CryptoApi as CryptoApi
+from authentik_client.api.endpoints_api import EndpointsApi as EndpointsApi
+from authentik_client.api.enterprise_api import EnterpriseApi as EnterpriseApi
+from authentik_client.api.events_api import EventsApi as EventsApi
+from authentik_client.api.flows_api import FlowsApi as FlowsApi
+from authentik_client.api.lifecycle_api import LifecycleApi as LifecycleApi
+from authentik_client.api.managed_api import ManagedApi as ManagedApi
+from authentik_client.api.oauth2_api import Oauth2Api as Oauth2Api
+from authentik_client.api.outposts_api import OutpostsApi as OutpostsApi
+from authentik_client.api.policies_api import PoliciesApi as PoliciesApi
+from authentik_client.api.propertymappings_api import PropertymappingsApi as PropertymappingsApi
+from authentik_client.api.providers_api import ProvidersApi as ProvidersApi
+from authentik_client.api.rac_api import RacApi as RacApi
+from authentik_client.api.rbac_api import RbacApi as RbacApi
+from authentik_client.api.reports_api import ReportsApi as ReportsApi
+from authentik_client.api.root_api import RootApi as RootApi
+from authentik_client.api.schema_api import SchemaApi as SchemaApi
+from authentik_client.api.sources_api import SourcesApi as SourcesApi
+from authentik_client.api.ssf_api import SsfApi as SsfApi
+from authentik_client.api.stages_api import StagesApi as StagesApi
+from authentik_client.api.tasks_api import TasksApi as TasksApi
+from authentik_client.api.tenants_api import TenantsApi as TenantsApi
+
+# import ApiClient
+from authentik_client.api_response import ApiResponse as ApiResponse
+from authentik_client.api_client import ApiClient as ApiClient
+from authentik_client.configuration import Configuration as Configuration
+from authentik_client.exceptions import OpenApiException as OpenApiException
+from authentik_client.exceptions import ApiTypeError as ApiTypeError
+from authentik_client.exceptions import ApiValueError as ApiValueError
+from authentik_client.exceptions import ApiKeyError as ApiKeyError
+from authentik_client.exceptions import ApiAttributeError as ApiAttributeError
+from authentik_client.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from authentik_client.models.access_denied_challenge import AccessDeniedChallenge as AccessDeniedChallenge
+from authentik_client.models.account_lockdown_stage import AccountLockdownStage as AccountLockdownStage
+from authentik_client.models.account_lockdown_stage_request import AccountLockdownStageRequest as AccountLockdownStageRequest
+from authentik_client.models.agent_authentication_response import AgentAuthenticationResponse as AgentAuthenticationResponse
+from authentik_client.models.agent_config import AgentConfig as AgentConfig
+from authentik_client.models.agent_connector import AgentConnector as AgentConnector
+from authentik_client.models.agent_connector_request import AgentConnectorRequest as AgentConnectorRequest
+from authentik_client.models.agent_psso_device_registration_request import AgentPSSODeviceRegistrationRequest as AgentPSSODeviceRegistrationRequest
+from authentik_client.models.agent_psso_device_registration_response import AgentPSSODeviceRegistrationResponse as AgentPSSODeviceRegistrationResponse
+from authentik_client.models.agent_psso_user_registration_request import AgentPSSOUserRegistrationRequest as AgentPSSOUserRegistrationRequest
+from authentik_client.models.agent_token_response import AgentTokenResponse as AgentTokenResponse
+from authentik_client.models.alg_enum import AlgEnum as AlgEnum
+from authentik_client.models.app import App as App
+from authentik_client.models.app_enum import AppEnum as AppEnum
+from authentik_client.models.apple_challenge_response_request import AppleChallengeResponseRequest as AppleChallengeResponseRequest
+from authentik_client.models.apple_independent_secure_enclave import AppleIndependentSecureEnclave as AppleIndependentSecureEnclave
+from authentik_client.models.apple_independent_secure_enclave_request import AppleIndependentSecureEnclaveRequest as AppleIndependentSecureEnclaveRequest
+from authentik_client.models.apple_login_challenge import AppleLoginChallenge as AppleLoginChallenge
+from authentik_client.models.application import Application as Application
+from authentik_client.models.application_entitlement import ApplicationEntitlement as ApplicationEntitlement
+from authentik_client.models.application_entitlement_request import ApplicationEntitlementRequest as ApplicationEntitlementRequest
+from authentik_client.models.application_request import ApplicationRequest as ApplicationRequest
+from authentik_client.models.auth_type_enum import AuthTypeEnum as AuthTypeEnum
+from authentik_client.models.authenticated_session import AuthenticatedSession as AuthenticatedSession
+from authentik_client.models.authenticated_session_asn import AuthenticatedSessionAsn as AuthenticatedSessionAsn
+from authentik_client.models.authenticated_session_geo_ip import AuthenticatedSessionGeoIp as AuthenticatedSessionGeoIp
+from authentik_client.models.authenticated_session_user_agent import AuthenticatedSessionUserAgent as AuthenticatedSessionUserAgent
+from authentik_client.models.authenticated_session_user_agent_device import AuthenticatedSessionUserAgentDevice as AuthenticatedSessionUserAgentDevice
+from authentik_client.models.authenticated_session_user_agent_os import AuthenticatedSessionUserAgentOs as AuthenticatedSessionUserAgentOs
+from authentik_client.models.authenticated_session_user_agent_user_agent import AuthenticatedSessionUserAgentUserAgent as AuthenticatedSessionUserAgentUserAgent
+from authentik_client.models.authentication_enum import AuthenticationEnum as AuthenticationEnum
+from authentik_client.models.authenticator_attachment_enum import AuthenticatorAttachmentEnum as AuthenticatorAttachmentEnum
+from authentik_client.models.authenticator_duo_challenge import AuthenticatorDuoChallenge as AuthenticatorDuoChallenge
+from authentik_client.models.authenticator_duo_challenge_response_request import AuthenticatorDuoChallengeResponseRequest as AuthenticatorDuoChallengeResponseRequest
+from authentik_client.models.authenticator_duo_stage import AuthenticatorDuoStage as AuthenticatorDuoStage
+from authentik_client.models.authenticator_duo_stage_device_import_response import AuthenticatorDuoStageDeviceImportResponse as AuthenticatorDuoStageDeviceImportResponse
+from authentik_client.models.authenticator_duo_stage_manual_device_import_request import AuthenticatorDuoStageManualDeviceImportRequest as AuthenticatorDuoStageManualDeviceImportRequest
+from authentik_client.models.authenticator_duo_stage_request import AuthenticatorDuoStageRequest as AuthenticatorDuoStageRequest
+from authentik_client.models.authenticator_email_challenge import AuthenticatorEmailChallenge as AuthenticatorEmailChallenge
+from authentik_client.models.authenticator_email_challenge_response_request import AuthenticatorEmailChallengeResponseRequest as AuthenticatorEmailChallengeResponseRequest
+from authentik_client.models.authenticator_email_stage import AuthenticatorEmailStage as AuthenticatorEmailStage
+from authentik_client.models.authenticator_email_stage_request import AuthenticatorEmailStageRequest as AuthenticatorEmailStageRequest
+from authentik_client.models.authenticator_endpoint_gdtc_stage import AuthenticatorEndpointGDTCStage as AuthenticatorEndpointGDTCStage
+from authentik_client.models.authenticator_endpoint_gdtc_stage_request import AuthenticatorEndpointGDTCStageRequest as AuthenticatorEndpointGDTCStageRequest
+from authentik_client.models.authenticator_sms_challenge import AuthenticatorSMSChallenge as AuthenticatorSMSChallenge
+from authentik_client.models.authenticator_sms_challenge_response_request import AuthenticatorSMSChallengeResponseRequest as AuthenticatorSMSChallengeResponseRequest
+from authentik_client.models.authenticator_sms_stage import AuthenticatorSMSStage as AuthenticatorSMSStage
+from authentik_client.models.authenticator_sms_stage_request import AuthenticatorSMSStageRequest as AuthenticatorSMSStageRequest
+from authentik_client.models.authenticator_static_challenge import AuthenticatorStaticChallenge as AuthenticatorStaticChallenge
+from authentik_client.models.authenticator_static_challenge_response_request import AuthenticatorStaticChallengeResponseRequest as AuthenticatorStaticChallengeResponseRequest
+from authentik_client.models.authenticator_static_stage import AuthenticatorStaticStage as AuthenticatorStaticStage
+from authentik_client.models.authenticator_static_stage_request import AuthenticatorStaticStageRequest as AuthenticatorStaticStageRequest
+from authentik_client.models.authenticator_totp_challenge import AuthenticatorTOTPChallenge as AuthenticatorTOTPChallenge
+from authentik_client.models.authenticator_totp_challenge_response_request import AuthenticatorTOTPChallengeResponseRequest as AuthenticatorTOTPChallengeResponseRequest
+from authentik_client.models.authenticator_totp_stage import AuthenticatorTOTPStage as AuthenticatorTOTPStage
+from authentik_client.models.authenticator_totp_stage_request import AuthenticatorTOTPStageRequest as AuthenticatorTOTPStageRequest
+from authentik_client.models.authenticator_validate_stage import AuthenticatorValidateStage as AuthenticatorValidateStage
+from authentik_client.models.authenticator_validate_stage_request import AuthenticatorValidateStageRequest as AuthenticatorValidateStageRequest
+from authentik_client.models.authenticator_validation_challenge import AuthenticatorValidationChallenge as AuthenticatorValidationChallenge
+from authentik_client.models.authenticator_validation_challenge_response_request import AuthenticatorValidationChallengeResponseRequest as AuthenticatorValidationChallengeResponseRequest
+from authentik_client.models.authenticator_web_authn_challenge import AuthenticatorWebAuthnChallenge as AuthenticatorWebAuthnChallenge
+from authentik_client.models.authenticator_web_authn_challenge_response_request import AuthenticatorWebAuthnChallengeResponseRequest as AuthenticatorWebAuthnChallengeResponseRequest
+from authentik_client.models.authenticator_web_authn_stage import AuthenticatorWebAuthnStage as AuthenticatorWebAuthnStage
+from authentik_client.models.authenticator_web_authn_stage_request import AuthenticatorWebAuthnStageRequest as AuthenticatorWebAuthnStageRequest
+from authentik_client.models.authorization_code_auth_method_enum import AuthorizationCodeAuthMethodEnum as AuthorizationCodeAuthMethodEnum
+from authentik_client.models.auto_submit_challenge_response_request import AutoSubmitChallengeResponseRequest as AutoSubmitChallengeResponseRequest
+from authentik_client.models.autosubmit_challenge import AutosubmitChallenge as AutosubmitChallenge
+from authentik_client.models.backends_enum import BackendsEnum as BackendsEnum
+from authentik_client.models.binding_type_enum import BindingTypeEnum as BindingTypeEnum
+from authentik_client.models.blueprint_file import BlueprintFile as BlueprintFile
+from authentik_client.models.blueprint_import_result import BlueprintImportResult as BlueprintImportResult
+from authentik_client.models.blueprint_instance import BlueprintInstance as BlueprintInstance
+from authentik_client.models.blueprint_instance_request import BlueprintInstanceRequest as BlueprintInstanceRequest
+from authentik_client.models.blueprint_instance_status_enum import BlueprintInstanceStatusEnum as BlueprintInstanceStatusEnum
+from authentik_client.models.brand import Brand as Brand
+from authentik_client.models.brand_request import BrandRequest as BrandRequest
+from authentik_client.models.bulk_delete_session_response import BulkDeleteSessionResponse as BulkDeleteSessionResponse
+from authentik_client.models.cache import Cache as Cache
+from authentik_client.models.capabilities_enum import CapabilitiesEnum as CapabilitiesEnum
+from authentik_client.models.captcha_challenge import CaptchaChallenge as CaptchaChallenge
+from authentik_client.models.captcha_challenge_response_request import CaptchaChallengeResponseRequest as CaptchaChallengeResponseRequest
+from authentik_client.models.captcha_stage import CaptchaStage as CaptchaStage
+from authentik_client.models.captcha_stage_request import CaptchaStageRequest as CaptchaStageRequest
+from authentik_client.models.cert_attribute_enum import CertAttributeEnum as CertAttributeEnum
+from authentik_client.models.certificate_data import CertificateData as CertificateData
+from authentik_client.models.certificate_generation_request import CertificateGenerationRequest as CertificateGenerationRequest
+from authentik_client.models.certificate_key_pair import CertificateKeyPair as CertificateKeyPair
+from authentik_client.models.certificate_key_pair_key_type_enum import CertificateKeyPairKeyTypeEnum as CertificateKeyPairKeyTypeEnum
+from authentik_client.models.certificate_key_pair_request import CertificateKeyPairRequest as CertificateKeyPairRequest
+from authentik_client.models.challenge_types import ChallengeTypes as ChallengeTypes
+from authentik_client.models.client_type_enum import ClientTypeEnum as ClientTypeEnum
+from authentik_client.models.compatibility_mode_enum import CompatibilityModeEnum as CompatibilityModeEnum
+from authentik_client.models.config import Config as Config
+from authentik_client.models.connection_token import ConnectionToken as ConnectionToken
+from authentik_client.models.connection_token_request import ConnectionTokenRequest as ConnectionTokenRequest
+from authentik_client.models.connector import Connector as Connector
+from authentik_client.models.consent_challenge import ConsentChallenge as ConsentChallenge
+from authentik_client.models.consent_challenge_response_request import ConsentChallengeResponseRequest as ConsentChallengeResponseRequest
+from authentik_client.models.consent_mode_enum import ConsentModeEnum as ConsentModeEnum
+from authentik_client.models.consent_permission import ConsentPermission as ConsentPermission
+from authentik_client.models.consent_stage import ConsentStage as ConsentStage
+from authentik_client.models.consent_stage_request import ConsentStageRequest as ConsentStageRequest
+from authentik_client.models.content_type import ContentType as ContentType
+from authentik_client.models.content_type_enum import ContentTypeEnum as ContentTypeEnum
+from authentik_client.models.contextual_flow_info import ContextualFlowInfo as ContextualFlowInfo
+from authentik_client.models.contextual_flow_info_layout_enum import ContextualFlowInfoLayoutEnum as ContextualFlowInfoLayoutEnum
+from authentik_client.models.country_code_enum import CountryCodeEnum as CountryCodeEnum
+from authentik_client.models.current_brand import CurrentBrand as CurrentBrand
+from authentik_client.models.current_brand_flags import CurrentBrandFlags as CurrentBrandFlags
+from authentik_client.models.data_export import DataExport as DataExport
+from authentik_client.models.delivery_method_enum import DeliveryMethodEnum as DeliveryMethodEnum
+from authentik_client.models.denied_action_enum import DeniedActionEnum as DeniedActionEnum
+from authentik_client.models.deny_stage import DenyStage as DenyStage
+from authentik_client.models.deny_stage_request import DenyStageRequest as DenyStageRequest
+from authentik_client.models.detailed_country import DetailedCountry as DetailedCountry
+from authentik_client.models.device import Device as Device
+from authentik_client.models.device_access_group import DeviceAccessGroup as DeviceAccessGroup
+from authentik_client.models.device_access_group_request import DeviceAccessGroupRequest as DeviceAccessGroupRequest
+from authentik_client.models.device_challenge import DeviceChallenge as DeviceChallenge
+from authentik_client.models.device_challenge_request import DeviceChallengeRequest as DeviceChallengeRequest
+from authentik_client.models.device_classes_enum import DeviceClassesEnum as DeviceClassesEnum
+from authentik_client.models.device_connection import DeviceConnection as DeviceConnection
+from authentik_client.models.device_fact_snapshot import DeviceFactSnapshot as DeviceFactSnapshot
+from authentik_client.models.device_facts import DeviceFacts as DeviceFacts
+from authentik_client.models.device_facts_os_family import DeviceFactsOSFamily as DeviceFactsOSFamily
+from authentik_client.models.device_facts_request import DeviceFactsRequest as DeviceFactsRequest
+from authentik_client.models.device_group import DeviceGroup as DeviceGroup
+from authentik_client.models.device_group_request import DeviceGroupRequest as DeviceGroupRequest
+from authentik_client.models.device_summary import DeviceSummary as DeviceSummary
+from authentik_client.models.device_user import DeviceUser as DeviceUser
+from authentik_client.models.device_user_binding import DeviceUserBinding as DeviceUserBinding
+from authentik_client.models.device_user_binding_request import DeviceUserBindingRequest as DeviceUserBindingRequest
+from authentik_client.models.device_user_request import DeviceUserRequest as DeviceUserRequest
+from authentik_client.models.digest_algorithm_enum import DigestAlgorithmEnum as DigestAlgorithmEnum
+from authentik_client.models.digits_enum import DigitsEnum as DigitsEnum
+from authentik_client.models.disk import Disk as Disk
+from authentik_client.models.disk_request import DiskRequest as DiskRequest
+from authentik_client.models.docker_service_connection import DockerServiceConnection as DockerServiceConnection
+from authentik_client.models.docker_service_connection_request import DockerServiceConnectionRequest as DockerServiceConnectionRequest
+from authentik_client.models.domain import Domain as Domain
+from authentik_client.models.domain_request import DomainRequest as DomainRequest
+from authentik_client.models.dummy_challenge import DummyChallenge as DummyChallenge
+from authentik_client.models.dummy_challenge_response_request import DummyChallengeResponseRequest as DummyChallengeResponseRequest
+from authentik_client.models.dummy_policy import DummyPolicy as DummyPolicy
+from authentik_client.models.dummy_policy_request import DummyPolicyRequest as DummyPolicyRequest
+from authentik_client.models.dummy_stage import DummyStage as DummyStage
+from authentik_client.models.dummy_stage_request import DummyStageRequest as DummyStageRequest
+from authentik_client.models.duo_device import DuoDevice as DuoDevice
+from authentik_client.models.duo_device_enrollment_status import DuoDeviceEnrollmentStatus as DuoDeviceEnrollmentStatus
+from authentik_client.models.duo_device_request import DuoDeviceRequest as DuoDeviceRequest
+from authentik_client.models.duo_response_enum import DuoResponseEnum as DuoResponseEnum
+from authentik_client.models.email_challenge import EmailChallenge as EmailChallenge
+from authentik_client.models.email_challenge_response_request import EmailChallengeResponseRequest as EmailChallengeResponseRequest
+from authentik_client.models.email_device import EmailDevice as EmailDevice
+from authentik_client.models.email_device_request import EmailDeviceRequest as EmailDeviceRequest
+from authentik_client.models.email_stage import EmailStage as EmailStage
+from authentik_client.models.email_stage_request import EmailStageRequest as EmailStageRequest
+from authentik_client.models.endpoint import Endpoint as Endpoint
+from authentik_client.models.endpoint_agent_challenge import EndpointAgentChallenge as EndpointAgentChallenge
+from authentik_client.models.endpoint_agent_challenge_response_request import EndpointAgentChallengeResponseRequest as EndpointAgentChallengeResponseRequest
+from authentik_client.models.endpoint_auth_mode_enum import EndpointAuthModeEnum as EndpointAuthModeEnum
+from authentik_client.models.endpoint_device import EndpointDevice as EndpointDevice
+from authentik_client.models.endpoint_device_details import EndpointDeviceDetails as EndpointDeviceDetails
+from authentik_client.models.endpoint_device_request import EndpointDeviceRequest as EndpointDeviceRequest
+from authentik_client.models.endpoint_request import EndpointRequest as EndpointRequest
+from authentik_client.models.endpoint_stage import EndpointStage as EndpointStage
+from authentik_client.models.endpoint_stage_request import EndpointStageRequest as EndpointStageRequest
+from authentik_client.models.enroll_request import EnrollRequest as EnrollRequest
+from authentik_client.models.enrollment_token import EnrollmentToken as EnrollmentToken
+from authentik_client.models.enrollment_token_request import EnrollmentTokenRequest as EnrollmentTokenRequest
+from authentik_client.models.error_detail import ErrorDetail as ErrorDetail
+from authentik_client.models.error_reporting_config import ErrorReportingConfig as ErrorReportingConfig
+from authentik_client.models.event import Event as Event
+from authentik_client.models.event_actions import EventActions as EventActions
+from authentik_client.models.event_matcher_policy import EventMatcherPolicy as EventMatcherPolicy
+from authentik_client.models.event_matcher_policy_request import EventMatcherPolicyRequest as EventMatcherPolicyRequest
+from authentik_client.models.event_request import EventRequest as EventRequest
+from authentik_client.models.event_stats import EventStats as EventStats
+from authentik_client.models.event_top_per_user import EventTopPerUser as EventTopPerUser
+from authentik_client.models.event_volume import EventVolume as EventVolume
+from authentik_client.models.events_requested_enum import EventsRequestedEnum as EventsRequestedEnum
+from authentik_client.models.expiring_base_grant_model import ExpiringBaseGrantModel as ExpiringBaseGrantModel
+from authentik_client.models.expression_policy import ExpressionPolicy as ExpressionPolicy
+from authentik_client.models.expression_policy_request import ExpressionPolicyRequest as ExpressionPolicyRequest
+from authentik_client.models.extra_role_object_permission import ExtraRoleObjectPermission as ExtraRoleObjectPermission
+from authentik_client.models.file_list import FileList as FileList
+from authentik_client.models.fleet_connector import FleetConnector as FleetConnector
+from authentik_client.models.fleet_connector_request import FleetConnectorRequest as FleetConnectorRequest
+from authentik_client.models.flow import Flow as Flow
+from authentik_client.models.flow_challenge_response_request import FlowChallengeResponseRequest as FlowChallengeResponseRequest
+from authentik_client.models.flow_designation_enum import FlowDesignationEnum as FlowDesignationEnum
+from authentik_client.models.flow_diagram import FlowDiagram as FlowDiagram
+from authentik_client.models.flow_error_challenge import FlowErrorChallenge as FlowErrorChallenge
+from authentik_client.models.flow_inspection import FlowInspection as FlowInspection
+from authentik_client.models.flow_inspector_plan import FlowInspectorPlan as FlowInspectorPlan
+from authentik_client.models.flow_layout_enum import FlowLayoutEnum as FlowLayoutEnum
+from authentik_client.models.flow_request import FlowRequest as FlowRequest
+from authentik_client.models.flow_set import FlowSet as FlowSet
+from authentik_client.models.flow_stage_binding import FlowStageBinding as FlowStageBinding
+from authentik_client.models.flow_stage_binding_request import FlowStageBindingRequest as FlowStageBindingRequest
+from authentik_client.models.footer_link import FooterLink as FooterLink
+from authentik_client.models.force_binding_enum import ForceBindingEnum as ForceBindingEnum
+from authentik_client.models.format_enum import FormatEnum as FormatEnum
+from authentik_client.models.frame_challenge import FrameChallenge as FrameChallenge
+from authentik_client.models.frame_challenge_response_request import FrameChallengeResponseRequest as FrameChallengeResponseRequest
+from authentik_client.models.generic_error import GenericError as GenericError
+from authentik_client.models.geo_ip_policy import GeoIPPolicy as GeoIPPolicy
+from authentik_client.models.geo_ip_policy_countries_obj_inner import GeoIPPolicyCountriesObjInner as GeoIPPolicyCountriesObjInner
+from authentik_client.models.geo_ip_policy_request import GeoIPPolicyRequest as GeoIPPolicyRequest
+from authentik_client.models.geoip_binding_enum import GeoipBindingEnum as GeoipBindingEnum
+from authentik_client.models.global_task_status import GlobalTaskStatus as GlobalTaskStatus
+from authentik_client.models.google_chrome_connector import GoogleChromeConnector as GoogleChromeConnector
+from authentik_client.models.google_chrome_connector_request import GoogleChromeConnectorRequest as GoogleChromeConnectorRequest
+from authentik_client.models.google_endpoint_device import GoogleEndpointDevice as GoogleEndpointDevice
+from authentik_client.models.google_endpoint_device_request import GoogleEndpointDeviceRequest as GoogleEndpointDeviceRequest
+from authentik_client.models.google_workspace_provider import GoogleWorkspaceProvider as GoogleWorkspaceProvider
+from authentik_client.models.google_workspace_provider_group import GoogleWorkspaceProviderGroup as GoogleWorkspaceProviderGroup
+from authentik_client.models.google_workspace_provider_group_request import GoogleWorkspaceProviderGroupRequest as GoogleWorkspaceProviderGroupRequest
+from authentik_client.models.google_workspace_provider_mapping import GoogleWorkspaceProviderMapping as GoogleWorkspaceProviderMapping
+from authentik_client.models.google_workspace_provider_mapping_request import GoogleWorkspaceProviderMappingRequest as GoogleWorkspaceProviderMappingRequest
+from authentik_client.models.google_workspace_provider_request import GoogleWorkspaceProviderRequest as GoogleWorkspaceProviderRequest
+from authentik_client.models.google_workspace_provider_user import GoogleWorkspaceProviderUser as GoogleWorkspaceProviderUser
+from authentik_client.models.google_workspace_provider_user_request import GoogleWorkspaceProviderUserRequest as GoogleWorkspaceProviderUserRequest
+from authentik_client.models.grant_types_enum import GrantTypesEnum as GrantTypesEnum
+from authentik_client.models.group import Group as Group
+from authentik_client.models.group_kerberos_source_connection import GroupKerberosSourceConnection as GroupKerberosSourceConnection
+from authentik_client.models.group_kerberos_source_connection_request import GroupKerberosSourceConnectionRequest as GroupKerberosSourceConnectionRequest
+from authentik_client.models.group_ldap_source_connection import GroupLDAPSourceConnection as GroupLDAPSourceConnection
+from authentik_client.models.group_ldap_source_connection_request import GroupLDAPSourceConnectionRequest as GroupLDAPSourceConnectionRequest
+from authentik_client.models.group_matching_mode_enum import GroupMatchingModeEnum as GroupMatchingModeEnum
+from authentik_client.models.group_o_auth_source_connection import GroupOAuthSourceConnection as GroupOAuthSourceConnection
+from authentik_client.models.group_o_auth_source_connection_request import GroupOAuthSourceConnectionRequest as GroupOAuthSourceConnectionRequest
+from authentik_client.models.group_plex_source_connection import GroupPlexSourceConnection as GroupPlexSourceConnection
+from authentik_client.models.group_plex_source_connection_request import GroupPlexSourceConnectionRequest as GroupPlexSourceConnectionRequest
+from authentik_client.models.group_request import GroupRequest as GroupRequest
+from authentik_client.models.group_saml_source_connection import GroupSAMLSourceConnection as GroupSAMLSourceConnection
+from authentik_client.models.group_saml_source_connection_request import GroupSAMLSourceConnectionRequest as GroupSAMLSourceConnectionRequest
+from authentik_client.models.group_source_connection import GroupSourceConnection as GroupSourceConnection
+from authentik_client.models.group_source_connection_request import GroupSourceConnectionRequest as GroupSourceConnectionRequest
+from authentik_client.models.group_telegram_source_connection import GroupTelegramSourceConnection as GroupTelegramSourceConnection
+from authentik_client.models.group_telegram_source_connection_request import GroupTelegramSourceConnectionRequest as GroupTelegramSourceConnectionRequest
+from authentik_client.models.hardware import Hardware as Hardware
+from authentik_client.models.hardware_request import HardwareRequest as HardwareRequest
+from authentik_client.models.identification_challenge import IdentificationChallenge as IdentificationChallenge
+from authentik_client.models.identification_challenge_response_request import IdentificationChallengeResponseRequest as IdentificationChallengeResponseRequest
+from authentik_client.models.identification_stage import IdentificationStage as IdentificationStage
+from authentik_client.models.identification_stage_request import IdentificationStageRequest as IdentificationStageRequest
+from authentik_client.models.iframe_logout_challenge import IframeLogoutChallenge as IframeLogoutChallenge
+from authentik_client.models.iframe_logout_challenge_response_request import IframeLogoutChallengeResponseRequest as IframeLogoutChallengeResponseRequest
+from authentik_client.models.impersonation_request import ImpersonationRequest as ImpersonationRequest
+from authentik_client.models.initial_permissions import InitialPermissions as InitialPermissions
+from authentik_client.models.initial_permissions_request import InitialPermissionsRequest as InitialPermissionsRequest
+from authentik_client.models.install_id import InstallID as InstallID
+from authentik_client.models.intent_enum import IntentEnum as IntentEnum
+from authentik_client.models.invalid_response_action_enum import InvalidResponseActionEnum as InvalidResponseActionEnum
+from authentik_client.models.invitation import Invitation as Invitation
+from authentik_client.models.invitation_request import InvitationRequest as InvitationRequest
+from authentik_client.models.invitation_send_email_request import InvitationSendEmailRequest as InvitationSendEmailRequest
+from authentik_client.models.invitation_stage import InvitationStage as InvitationStage
+from authentik_client.models.invitation_stage_request import InvitationStageRequest as InvitationStageRequest
+from authentik_client.models.issuer_mode_enum import IssuerModeEnum as IssuerModeEnum
+from authentik_client.models.kadmin_type_enum import KadminTypeEnum as KadminTypeEnum
+from authentik_client.models.kerberos_source import KerberosSource as KerberosSource
+from authentik_client.models.kerberos_source_property_mapping import KerberosSourcePropertyMapping as KerberosSourcePropertyMapping
+from authentik_client.models.kerberos_source_property_mapping_request import KerberosSourcePropertyMappingRequest as KerberosSourcePropertyMappingRequest
+from authentik_client.models.kerberos_source_request import KerberosSourceRequest as KerberosSourceRequest
+from authentik_client.models.key_type_enum import KeyTypeEnum as KeyTypeEnum
+from authentik_client.models.kubernetes_service_connection import KubernetesServiceConnection as KubernetesServiceConnection
+from authentik_client.models.kubernetes_service_connection_request import KubernetesServiceConnectionRequest as KubernetesServiceConnectionRequest
+from authentik_client.models.ldapapi_access_mode import LDAPAPIAccessMode as LDAPAPIAccessMode
+from authentik_client.models.ldap_check_access import LDAPCheckAccess as LDAPCheckAccess
+from authentik_client.models.ldap_debug import LDAPDebug as LDAPDebug
+from authentik_client.models.ldap_outpost_config import LDAPOutpostConfig as LDAPOutpostConfig
+from authentik_client.models.ldap_provider import LDAPProvider as LDAPProvider
+from authentik_client.models.ldap_provider_request import LDAPProviderRequest as LDAPProviderRequest
+from authentik_client.models.ldap_source import LDAPSource as LDAPSource
+from authentik_client.models.ldap_source_property_mapping import LDAPSourcePropertyMapping as LDAPSourcePropertyMapping
+from authentik_client.models.ldap_source_property_mapping_request import LDAPSourcePropertyMappingRequest as LDAPSourcePropertyMappingRequest
+from authentik_client.models.ldap_source_request import LDAPSourceRequest as LDAPSourceRequest
+from authentik_client.models.lang_enum import LangEnum as LangEnum
+from authentik_client.models.last_task_status_enum import LastTaskStatusEnum as LastTaskStatusEnum
+from authentik_client.models.license import License as License
+from authentik_client.models.license_flags_enum import LicenseFlagsEnum as LicenseFlagsEnum
+from authentik_client.models.license_forecast import LicenseForecast as LicenseForecast
+from authentik_client.models.license_request import LicenseRequest as LicenseRequest
+from authentik_client.models.license_status_enum import LicenseStatusEnum as LicenseStatusEnum
+from authentik_client.models.license_summary import LicenseSummary as LicenseSummary
+from authentik_client.models.license_summary_status_enum import LicenseSummaryStatusEnum as LicenseSummaryStatusEnum
+from authentik_client.models.lifecycle_iteration import LifecycleIteration as LifecycleIteration
+from authentik_client.models.lifecycle_iteration_request import LifecycleIterationRequest as LifecycleIterationRequest
+from authentik_client.models.lifecycle_iteration_state_enum import LifecycleIterationStateEnum as LifecycleIterationStateEnum
+from authentik_client.models.lifecycle_rule import LifecycleRule as LifecycleRule
+from authentik_client.models.lifecycle_rule_request import LifecycleRuleRequest as LifecycleRuleRequest
+from authentik_client.models.link import Link as Link
+from authentik_client.models.log_event import LogEvent as LogEvent
+from authentik_client.models.log_level_enum import LogLevelEnum as LogLevelEnum
+from authentik_client.models.login_challenge_types import LoginChallengeTypes as LoginChallengeTypes
+from authentik_client.models.login_source import LoginSource as LoginSource
+from authentik_client.models.logout_url import LogoutURL as LogoutURL
+from authentik_client.models.mdm_config_request import MDMConfigRequest as MDMConfigRequest
+from authentik_client.models.mdm_config_response import MDMConfigResponse as MDMConfigResponse
+from authentik_client.models.matching_mode_enum import MatchingModeEnum as MatchingModeEnum
+from authentik_client.models.metadata import Metadata as Metadata
+from authentik_client.models.microsoft_entra_provider import MicrosoftEntraProvider as MicrosoftEntraProvider
+from authentik_client.models.microsoft_entra_provider_group import MicrosoftEntraProviderGroup as MicrosoftEntraProviderGroup
+from authentik_client.models.microsoft_entra_provider_group_request import MicrosoftEntraProviderGroupRequest as MicrosoftEntraProviderGroupRequest
+from authentik_client.models.microsoft_entra_provider_mapping import MicrosoftEntraProviderMapping as MicrosoftEntraProviderMapping
+from authentik_client.models.microsoft_entra_provider_mapping_request import MicrosoftEntraProviderMappingRequest as MicrosoftEntraProviderMappingRequest
+from authentik_client.models.microsoft_entra_provider_request import MicrosoftEntraProviderRequest as MicrosoftEntraProviderRequest
+from authentik_client.models.microsoft_entra_provider_user import MicrosoftEntraProviderUser as MicrosoftEntraProviderUser
+from authentik_client.models.microsoft_entra_provider_user_request import MicrosoftEntraProviderUserRequest as MicrosoftEntraProviderUserRequest
+from authentik_client.models.model_enum import ModelEnum as ModelEnum
+from authentik_client.models.model_request import ModelRequest as ModelRequest
+from authentik_client.models.mutual_tls_stage import MutualTLSStage as MutualTLSStage
+from authentik_client.models.mutual_tls_stage_request import MutualTLSStageRequest as MutualTLSStageRequest
+from authentik_client.models.native_logout_challenge import NativeLogoutChallenge as NativeLogoutChallenge
+from authentik_client.models.native_logout_challenge_response_request import NativeLogoutChallengeResponseRequest as NativeLogoutChallengeResponseRequest
+from authentik_client.models.network import Network as Network
+from authentik_client.models.network_binding_enum import NetworkBindingEnum as NetworkBindingEnum
+from authentik_client.models.network_interface import NetworkInterface as NetworkInterface
+from authentik_client.models.network_interface_request import NetworkInterfaceRequest as NetworkInterfaceRequest
+from authentik_client.models.network_request import NetworkRequest as NetworkRequest
+from authentik_client.models.not_configured_action_enum import NotConfiguredActionEnum as NotConfiguredActionEnum
+from authentik_client.models.notification import Notification as Notification
+from authentik_client.models.notification_request import NotificationRequest as NotificationRequest
+from authentik_client.models.notification_rule import NotificationRule as NotificationRule
+from authentik_client.models.notification_rule_request import NotificationRuleRequest as NotificationRuleRequest
+from authentik_client.models.notification_transport import NotificationTransport as NotificationTransport
+from authentik_client.models.notification_transport_request import NotificationTransportRequest as NotificationTransportRequest
+from authentik_client.models.notification_transport_test import NotificationTransportTest as NotificationTransportTest
+from authentik_client.models.notification_webhook_mapping import NotificationWebhookMapping as NotificationWebhookMapping
+from authentik_client.models.notification_webhook_mapping_request import NotificationWebhookMappingRequest as NotificationWebhookMappingRequest
+from authentik_client.models.o_auth2_provider import OAuth2Provider as OAuth2Provider
+from authentik_client.models.o_auth2_provider_logout_method_enum import OAuth2ProviderLogoutMethodEnum as OAuth2ProviderLogoutMethodEnum
+from authentik_client.models.o_auth2_provider_request import OAuth2ProviderRequest as OAuth2ProviderRequest
+from authentik_client.models.o_auth2_provider_setup_urls import OAuth2ProviderSetupURLs as OAuth2ProviderSetupURLs
+from authentik_client.models.o_auth_device_code_challenge import OAuthDeviceCodeChallenge as OAuthDeviceCodeChallenge
+from authentik_client.models.o_auth_device_code_challenge_response_request import OAuthDeviceCodeChallengeResponseRequest as OAuthDeviceCodeChallengeResponseRequest
+from authentik_client.models.o_auth_device_code_finish_challenge import OAuthDeviceCodeFinishChallenge as OAuthDeviceCodeFinishChallenge
+from authentik_client.models.o_auth_device_code_finish_challenge_response_request import OAuthDeviceCodeFinishChallengeResponseRequest as OAuthDeviceCodeFinishChallengeResponseRequest
+from authentik_client.models.o_auth_source import OAuthSource as OAuthSource
+from authentik_client.models.o_auth_source_property_mapping import OAuthSourcePropertyMapping as OAuthSourcePropertyMapping
+from authentik_client.models.o_auth_source_property_mapping_request import OAuthSourcePropertyMappingRequest as OAuthSourcePropertyMappingRequest
+from authentik_client.models.o_auth_source_request import OAuthSourceRequest as OAuthSourceRequest
+from authentik_client.models.open_id_connect_configuration import OpenIDConnectConfiguration as OpenIDConnectConfiguration
+from authentik_client.models.operating_system import OperatingSystem as OperatingSystem
+from authentik_client.models.operating_system_request import OperatingSystemRequest as OperatingSystemRequest
+from authentik_client.models.outgoing_sync_delete_action import OutgoingSyncDeleteAction as OutgoingSyncDeleteAction
+from authentik_client.models.outpost import Outpost as Outpost
+from authentik_client.models.outpost_default_config import OutpostDefaultConfig as OutpostDefaultConfig
+from authentik_client.models.outpost_health import OutpostHealth as OutpostHealth
+from authentik_client.models.outpost_request import OutpostRequest as OutpostRequest
+from authentik_client.models.outpost_type_enum import OutpostTypeEnum as OutpostTypeEnum
+from authentik_client.models.pkce_method_enum import PKCEMethodEnum as PKCEMethodEnum
+from authentik_client.models.paginated_account_lockdown_stage_list import PaginatedAccountLockdownStageList as PaginatedAccountLockdownStageList
+from authentik_client.models.paginated_agent_connector_list import PaginatedAgentConnectorList as PaginatedAgentConnectorList
+from authentik_client.models.paginated_apple_independent_secure_enclave_list import PaginatedAppleIndependentSecureEnclaveList as PaginatedAppleIndependentSecureEnclaveList
+from authentik_client.models.paginated_application_entitlement_list import PaginatedApplicationEntitlementList as PaginatedApplicationEntitlementList
+from authentik_client.models.paginated_application_list import PaginatedApplicationList as PaginatedApplicationList
+from authentik_client.models.paginated_authenticated_session_list import PaginatedAuthenticatedSessionList as PaginatedAuthenticatedSessionList
+from authentik_client.models.paginated_authenticator_duo_stage_list import PaginatedAuthenticatorDuoStageList as PaginatedAuthenticatorDuoStageList
+from authentik_client.models.paginated_authenticator_email_stage_list import PaginatedAuthenticatorEmailStageList as PaginatedAuthenticatorEmailStageList
+from authentik_client.models.paginated_authenticator_endpoint_gdtc_stage_list import PaginatedAuthenticatorEndpointGDTCStageList as PaginatedAuthenticatorEndpointGDTCStageList
+from authentik_client.models.paginated_authenticator_sms_stage_list import PaginatedAuthenticatorSMSStageList as PaginatedAuthenticatorSMSStageList
+from authentik_client.models.paginated_authenticator_static_stage_list import PaginatedAuthenticatorStaticStageList as PaginatedAuthenticatorStaticStageList
+from authentik_client.models.paginated_authenticator_totp_stage_list import PaginatedAuthenticatorTOTPStageList as PaginatedAuthenticatorTOTPStageList
+from authentik_client.models.paginated_authenticator_validate_stage_list import PaginatedAuthenticatorValidateStageList as PaginatedAuthenticatorValidateStageList
+from authentik_client.models.paginated_authenticator_web_authn_stage_list import PaginatedAuthenticatorWebAuthnStageList as PaginatedAuthenticatorWebAuthnStageList
+from authentik_client.models.paginated_blueprint_instance_list import PaginatedBlueprintInstanceList as PaginatedBlueprintInstanceList
+from authentik_client.models.paginated_brand_list import PaginatedBrandList as PaginatedBrandList
+from authentik_client.models.paginated_captcha_stage_list import PaginatedCaptchaStageList as PaginatedCaptchaStageList
+from authentik_client.models.paginated_certificate_key_pair_list import PaginatedCertificateKeyPairList as PaginatedCertificateKeyPairList
+from authentik_client.models.paginated_connection_token_list import PaginatedConnectionTokenList as PaginatedConnectionTokenList
+from authentik_client.models.paginated_connector_list import PaginatedConnectorList as PaginatedConnectorList
+from authentik_client.models.paginated_consent_stage_list import PaginatedConsentStageList as PaginatedConsentStageList
+from authentik_client.models.paginated_data_export_list import PaginatedDataExportList as PaginatedDataExportList
+from authentik_client.models.paginated_deny_stage_list import PaginatedDenyStageList as PaginatedDenyStageList
+from authentik_client.models.paginated_device_access_group_list import PaginatedDeviceAccessGroupList as PaginatedDeviceAccessGroupList
+from authentik_client.models.paginated_device_user_binding_list import PaginatedDeviceUserBindingList as PaginatedDeviceUserBindingList
+from authentik_client.models.paginated_docker_service_connection_list import PaginatedDockerServiceConnectionList as PaginatedDockerServiceConnectionList
+from authentik_client.models.paginated_domain_list import PaginatedDomainList as PaginatedDomainList
+from authentik_client.models.paginated_dummy_policy_list import PaginatedDummyPolicyList as PaginatedDummyPolicyList
+from authentik_client.models.paginated_dummy_stage_list import PaginatedDummyStageList as PaginatedDummyStageList
+from authentik_client.models.paginated_duo_device_list import PaginatedDuoDeviceList as PaginatedDuoDeviceList
+from authentik_client.models.paginated_email_device_list import PaginatedEmailDeviceList as PaginatedEmailDeviceList
+from authentik_client.models.paginated_email_stage_list import PaginatedEmailStageList as PaginatedEmailStageList
+from authentik_client.models.paginated_endpoint_device_list import PaginatedEndpointDeviceList as PaginatedEndpointDeviceList
+from authentik_client.models.paginated_endpoint_list import PaginatedEndpointList as PaginatedEndpointList
+from authentik_client.models.paginated_endpoint_stage_list import PaginatedEndpointStageList as PaginatedEndpointStageList
+from authentik_client.models.paginated_enrollment_token_list import PaginatedEnrollmentTokenList as PaginatedEnrollmentTokenList
+from authentik_client.models.paginated_event_list import PaginatedEventList as PaginatedEventList
+from authentik_client.models.paginated_event_matcher_policy_list import PaginatedEventMatcherPolicyList as PaginatedEventMatcherPolicyList
+from authentik_client.models.paginated_expiring_base_grant_model_list import PaginatedExpiringBaseGrantModelList as PaginatedExpiringBaseGrantModelList
+from authentik_client.models.paginated_expression_policy_list import PaginatedExpressionPolicyList as PaginatedExpressionPolicyList
+from authentik_client.models.paginated_extra_role_object_permission_list import PaginatedExtraRoleObjectPermissionList as PaginatedExtraRoleObjectPermissionList
+from authentik_client.models.paginated_fleet_connector_list import PaginatedFleetConnectorList as PaginatedFleetConnectorList
+from authentik_client.models.paginated_flow_list import PaginatedFlowList as PaginatedFlowList
+from authentik_client.models.paginated_flow_stage_binding_list import PaginatedFlowStageBindingList as PaginatedFlowStageBindingList
+from authentik_client.models.paginated_geo_ip_policy_list import PaginatedGeoIPPolicyList as PaginatedGeoIPPolicyList
+from authentik_client.models.paginated_google_chrome_connector_list import PaginatedGoogleChromeConnectorList as PaginatedGoogleChromeConnectorList
+from authentik_client.models.paginated_google_endpoint_device_list import PaginatedGoogleEndpointDeviceList as PaginatedGoogleEndpointDeviceList
+from authentik_client.models.paginated_google_workspace_provider_group_list import PaginatedGoogleWorkspaceProviderGroupList as PaginatedGoogleWorkspaceProviderGroupList
+from authentik_client.models.paginated_google_workspace_provider_list import PaginatedGoogleWorkspaceProviderList as PaginatedGoogleWorkspaceProviderList
+from authentik_client.models.paginated_google_workspace_provider_mapping_list import PaginatedGoogleWorkspaceProviderMappingList as PaginatedGoogleWorkspaceProviderMappingList
+from authentik_client.models.paginated_google_workspace_provider_user_list import PaginatedGoogleWorkspaceProviderUserList as PaginatedGoogleWorkspaceProviderUserList
+from authentik_client.models.paginated_group_kerberos_source_connection_list import PaginatedGroupKerberosSourceConnectionList as PaginatedGroupKerberosSourceConnectionList
+from authentik_client.models.paginated_group_ldap_source_connection_list import PaginatedGroupLDAPSourceConnectionList as PaginatedGroupLDAPSourceConnectionList
+from authentik_client.models.paginated_group_list import PaginatedGroupList as PaginatedGroupList
+from authentik_client.models.paginated_group_o_auth_source_connection_list import PaginatedGroupOAuthSourceConnectionList as PaginatedGroupOAuthSourceConnectionList
+from authentik_client.models.paginated_group_plex_source_connection_list import PaginatedGroupPlexSourceConnectionList as PaginatedGroupPlexSourceConnectionList
+from authentik_client.models.paginated_group_saml_source_connection_list import PaginatedGroupSAMLSourceConnectionList as PaginatedGroupSAMLSourceConnectionList
+from authentik_client.models.paginated_group_source_connection_list import PaginatedGroupSourceConnectionList as PaginatedGroupSourceConnectionList
+from authentik_client.models.paginated_group_telegram_source_connection_list import PaginatedGroupTelegramSourceConnectionList as PaginatedGroupTelegramSourceConnectionList
+from authentik_client.models.paginated_identification_stage_list import PaginatedIdentificationStageList as PaginatedIdentificationStageList
+from authentik_client.models.paginated_initial_permissions_list import PaginatedInitialPermissionsList as PaginatedInitialPermissionsList
+from authentik_client.models.paginated_invitation_list import PaginatedInvitationList as PaginatedInvitationList
+from authentik_client.models.paginated_invitation_stage_list import PaginatedInvitationStageList as PaginatedInvitationStageList
+from authentik_client.models.paginated_kerberos_source_list import PaginatedKerberosSourceList as PaginatedKerberosSourceList
+from authentik_client.models.paginated_kerberos_source_property_mapping_list import PaginatedKerberosSourcePropertyMappingList as PaginatedKerberosSourcePropertyMappingList
+from authentik_client.models.paginated_kubernetes_service_connection_list import PaginatedKubernetesServiceConnectionList as PaginatedKubernetesServiceConnectionList
+from authentik_client.models.paginated_ldap_outpost_config_list import PaginatedLDAPOutpostConfigList as PaginatedLDAPOutpostConfigList
+from authentik_client.models.paginated_ldap_provider_list import PaginatedLDAPProviderList as PaginatedLDAPProviderList
+from authentik_client.models.paginated_ldap_source_list import PaginatedLDAPSourceList as PaginatedLDAPSourceList
+from authentik_client.models.paginated_ldap_source_property_mapping_list import PaginatedLDAPSourcePropertyMappingList as PaginatedLDAPSourcePropertyMappingList
+from authentik_client.models.paginated_license_list import PaginatedLicenseList as PaginatedLicenseList
+from authentik_client.models.paginated_lifecycle_iteration_list import PaginatedLifecycleIterationList as PaginatedLifecycleIterationList
+from authentik_client.models.paginated_lifecycle_rule_list import PaginatedLifecycleRuleList as PaginatedLifecycleRuleList
+from authentik_client.models.paginated_microsoft_entra_provider_group_list import PaginatedMicrosoftEntraProviderGroupList as PaginatedMicrosoftEntraProviderGroupList
+from authentik_client.models.paginated_microsoft_entra_provider_list import PaginatedMicrosoftEntraProviderList as PaginatedMicrosoftEntraProviderList
+from authentik_client.models.paginated_microsoft_entra_provider_mapping_list import PaginatedMicrosoftEntraProviderMappingList as PaginatedMicrosoftEntraProviderMappingList
+from authentik_client.models.paginated_microsoft_entra_provider_user_list import PaginatedMicrosoftEntraProviderUserList as PaginatedMicrosoftEntraProviderUserList
+from authentik_client.models.paginated_mutual_tls_stage_list import PaginatedMutualTLSStageList as PaginatedMutualTLSStageList
+from authentik_client.models.paginated_notification_list import PaginatedNotificationList as PaginatedNotificationList
+from authentik_client.models.paginated_notification_rule_list import PaginatedNotificationRuleList as PaginatedNotificationRuleList
+from authentik_client.models.paginated_notification_transport_list import PaginatedNotificationTransportList as PaginatedNotificationTransportList
+from authentik_client.models.paginated_notification_webhook_mapping_list import PaginatedNotificationWebhookMappingList as PaginatedNotificationWebhookMappingList
+from authentik_client.models.paginated_o_auth2_provider_list import PaginatedOAuth2ProviderList as PaginatedOAuth2ProviderList
+from authentik_client.models.paginated_o_auth_source_list import PaginatedOAuthSourceList as PaginatedOAuthSourceList
+from authentik_client.models.paginated_o_auth_source_property_mapping_list import PaginatedOAuthSourcePropertyMappingList as PaginatedOAuthSourcePropertyMappingList
+from authentik_client.models.paginated_outpost_list import PaginatedOutpostList as PaginatedOutpostList
+from authentik_client.models.paginated_password_expiry_policy_list import PaginatedPasswordExpiryPolicyList as PaginatedPasswordExpiryPolicyList
+from authentik_client.models.paginated_password_policy_list import PaginatedPasswordPolicyList as PaginatedPasswordPolicyList
+from authentik_client.models.paginated_password_stage_list import PaginatedPasswordStageList as PaginatedPasswordStageList
+from authentik_client.models.paginated_permission_list import PaginatedPermissionList as PaginatedPermissionList
+from authentik_client.models.paginated_plex_source_list import PaginatedPlexSourceList as PaginatedPlexSourceList
+from authentik_client.models.paginated_plex_source_property_mapping_list import PaginatedPlexSourcePropertyMappingList as PaginatedPlexSourcePropertyMappingList
+from authentik_client.models.paginated_policy_binding_list import PaginatedPolicyBindingList as PaginatedPolicyBindingList
+from authentik_client.models.paginated_policy_list import PaginatedPolicyList as PaginatedPolicyList
+from authentik_client.models.paginated_prompt_list import PaginatedPromptList as PaginatedPromptList
+from authentik_client.models.paginated_prompt_stage_list import PaginatedPromptStageList as PaginatedPromptStageList
+from authentik_client.models.paginated_property_mapping_list import PaginatedPropertyMappingList as PaginatedPropertyMappingList
+from authentik_client.models.paginated_provider_list import PaginatedProviderList as PaginatedProviderList
+from authentik_client.models.paginated_proxy_outpost_config_list import PaginatedProxyOutpostConfigList as PaginatedProxyOutpostConfigList
+from authentik_client.models.paginated_proxy_provider_list import PaginatedProxyProviderList as PaginatedProxyProviderList
+from authentik_client.models.paginated_rac_property_mapping_list import PaginatedRACPropertyMappingList as PaginatedRACPropertyMappingList
+from authentik_client.models.paginated_rac_provider_list import PaginatedRACProviderList as PaginatedRACProviderList
+from authentik_client.models.paginated_radius_outpost_config_list import PaginatedRadiusOutpostConfigList as PaginatedRadiusOutpostConfigList
+from authentik_client.models.paginated_radius_provider_list import PaginatedRadiusProviderList as PaginatedRadiusProviderList
+from authentik_client.models.paginated_radius_provider_property_mapping_list import PaginatedRadiusProviderPropertyMappingList as PaginatedRadiusProviderPropertyMappingList
+from authentik_client.models.paginated_redirect_stage_list import PaginatedRedirectStageList as PaginatedRedirectStageList
+from authentik_client.models.paginated_reputation_list import PaginatedReputationList as PaginatedReputationList
+from authentik_client.models.paginated_reputation_policy_list import PaginatedReputationPolicyList as PaginatedReputationPolicyList
+from authentik_client.models.paginated_role_assigned_object_permission_list import PaginatedRoleAssignedObjectPermissionList as PaginatedRoleAssignedObjectPermissionList
+from authentik_client.models.paginated_role_list import PaginatedRoleList as PaginatedRoleList
+from authentik_client.models.paginated_saml_property_mapping_list import PaginatedSAMLPropertyMappingList as PaginatedSAMLPropertyMappingList
+from authentik_client.models.paginated_saml_provider_list import PaginatedSAMLProviderList as PaginatedSAMLProviderList
+from authentik_client.models.paginated_saml_source_list import PaginatedSAMLSourceList as PaginatedSAMLSourceList
+from authentik_client.models.paginated_saml_source_property_mapping_list import PaginatedSAMLSourcePropertyMappingList as PaginatedSAMLSourcePropertyMappingList
+from authentik_client.models.paginated_scim_mapping_list import PaginatedSCIMMappingList as PaginatedSCIMMappingList
+from authentik_client.models.paginated_scim_provider_group_list import PaginatedSCIMProviderGroupList as PaginatedSCIMProviderGroupList
+from authentik_client.models.paginated_scim_provider_list import PaginatedSCIMProviderList as PaginatedSCIMProviderList
+from authentik_client.models.paginated_scim_provider_user_list import PaginatedSCIMProviderUserList as PaginatedSCIMProviderUserList
+from authentik_client.models.paginated_scim_source_group_list import PaginatedSCIMSourceGroupList as PaginatedSCIMSourceGroupList
+from authentik_client.models.paginated_scim_source_list import PaginatedSCIMSourceList as PaginatedSCIMSourceList
+from authentik_client.models.paginated_scim_source_property_mapping_list import PaginatedSCIMSourcePropertyMappingList as PaginatedSCIMSourcePropertyMappingList
+from authentik_client.models.paginated_scim_source_user_list import PaginatedSCIMSourceUserList as PaginatedSCIMSourceUserList
+from authentik_client.models.paginated_sms_device_list import PaginatedSMSDeviceList as PaginatedSMSDeviceList
+from authentik_client.models.paginated_ssf_provider_list import PaginatedSSFProviderList as PaginatedSSFProviderList
+from authentik_client.models.paginated_ssf_stream_list import PaginatedSSFStreamList as PaginatedSSFStreamList
+from authentik_client.models.paginated_schedule_list import PaginatedScheduleList as PaginatedScheduleList
+from authentik_client.models.paginated_scope_mapping_list import PaginatedScopeMappingList as PaginatedScopeMappingList
+from authentik_client.models.paginated_service_connection_list import PaginatedServiceConnectionList as PaginatedServiceConnectionList
+from authentik_client.models.paginated_source_list import PaginatedSourceList as PaginatedSourceList
+from authentik_client.models.paginated_source_stage_list import PaginatedSourceStageList as PaginatedSourceStageList
+from authentik_client.models.paginated_stage_list import PaginatedStageList as PaginatedStageList
+from authentik_client.models.paginated_static_device_list import PaginatedStaticDeviceList as PaginatedStaticDeviceList
+from authentik_client.models.paginated_totp_device_list import PaginatedTOTPDeviceList as PaginatedTOTPDeviceList
+from authentik_client.models.paginated_task_list import PaginatedTaskList as PaginatedTaskList
+from authentik_client.models.paginated_telegram_source_list import PaginatedTelegramSourceList as PaginatedTelegramSourceList
+from authentik_client.models.paginated_telegram_source_property_mapping_list import PaginatedTelegramSourcePropertyMappingList as PaginatedTelegramSourcePropertyMappingList
+from authentik_client.models.paginated_tenant_list import PaginatedTenantList as PaginatedTenantList
+from authentik_client.models.paginated_token_list import PaginatedTokenList as PaginatedTokenList
+from authentik_client.models.paginated_token_model_list import PaginatedTokenModelList as PaginatedTokenModelList
+from authentik_client.models.paginated_unique_password_policy_list import PaginatedUniquePasswordPolicyList as PaginatedUniquePasswordPolicyList
+from authentik_client.models.paginated_user_consent_list import PaginatedUserConsentList as PaginatedUserConsentList
+from authentik_client.models.paginated_user_delete_stage_list import PaginatedUserDeleteStageList as PaginatedUserDeleteStageList
+from authentik_client.models.paginated_user_kerberos_source_connection_list import PaginatedUserKerberosSourceConnectionList as PaginatedUserKerberosSourceConnectionList
+from authentik_client.models.paginated_user_ldap_source_connection_list import PaginatedUserLDAPSourceConnectionList as PaginatedUserLDAPSourceConnectionList
+from authentik_client.models.paginated_user_list import PaginatedUserList as PaginatedUserList
+from authentik_client.models.paginated_user_login_stage_list import PaginatedUserLoginStageList as PaginatedUserLoginStageList
+from authentik_client.models.paginated_user_logout_stage_list import PaginatedUserLogoutStageList as PaginatedUserLogoutStageList
+from authentik_client.models.paginated_user_o_auth_source_connection_list import PaginatedUserOAuthSourceConnectionList as PaginatedUserOAuthSourceConnectionList
+from authentik_client.models.paginated_user_plex_source_connection_list import PaginatedUserPlexSourceConnectionList as PaginatedUserPlexSourceConnectionList
+from authentik_client.models.paginated_user_saml_source_connection_list import PaginatedUserSAMLSourceConnectionList as PaginatedUserSAMLSourceConnectionList
+from authentik_client.models.paginated_user_source_connection_list import PaginatedUserSourceConnectionList as PaginatedUserSourceConnectionList
+from authentik_client.models.paginated_user_telegram_source_connection_list import PaginatedUserTelegramSourceConnectionList as PaginatedUserTelegramSourceConnectionList
+from authentik_client.models.paginated_user_write_stage_list import PaginatedUserWriteStageList as PaginatedUserWriteStageList
+from authentik_client.models.paginated_ws_federation_provider_list import PaginatedWSFederationProviderList as PaginatedWSFederationProviderList
+from authentik_client.models.paginated_web_authn_device_list import PaginatedWebAuthnDeviceList as PaginatedWebAuthnDeviceList
+from authentik_client.models.paginated_web_authn_device_type_list import PaginatedWebAuthnDeviceTypeList as PaginatedWebAuthnDeviceTypeList
+from authentik_client.models.pagination import Pagination as Pagination
+from authentik_client.models.partial_group import PartialGroup as PartialGroup
+from authentik_client.models.partial_user import PartialUser as PartialUser
+from authentik_client.models.password_challenge import PasswordChallenge as PasswordChallenge
+from authentik_client.models.password_challenge_response_request import PasswordChallengeResponseRequest as PasswordChallengeResponseRequest
+from authentik_client.models.password_expiry_policy import PasswordExpiryPolicy as PasswordExpiryPolicy
+from authentik_client.models.password_expiry_policy_request import PasswordExpiryPolicyRequest as PasswordExpiryPolicyRequest
+from authentik_client.models.password_policy import PasswordPolicy as PasswordPolicy
+from authentik_client.models.password_policy_request import PasswordPolicyRequest as PasswordPolicyRequest
+from authentik_client.models.password_stage import PasswordStage as PasswordStage
+from authentik_client.models.password_stage_request import PasswordStageRequest as PasswordStageRequest
+from authentik_client.models.patched_account_lockdown_stage_request import PatchedAccountLockdownStageRequest as PatchedAccountLockdownStageRequest
+from authentik_client.models.patched_agent_connector_request import PatchedAgentConnectorRequest as PatchedAgentConnectorRequest
+from authentik_client.models.patched_apple_independent_secure_enclave_request import PatchedAppleIndependentSecureEnclaveRequest as PatchedAppleIndependentSecureEnclaveRequest
+from authentik_client.models.patched_application_entitlement_request import PatchedApplicationEntitlementRequest as PatchedApplicationEntitlementRequest
+from authentik_client.models.patched_application_request import PatchedApplicationRequest as PatchedApplicationRequest
+from authentik_client.models.patched_authenticator_duo_stage_request import PatchedAuthenticatorDuoStageRequest as PatchedAuthenticatorDuoStageRequest
+from authentik_client.models.patched_authenticator_email_stage_request import PatchedAuthenticatorEmailStageRequest as PatchedAuthenticatorEmailStageRequest
+from authentik_client.models.patched_authenticator_endpoint_gdtc_stage_request import PatchedAuthenticatorEndpointGDTCStageRequest as PatchedAuthenticatorEndpointGDTCStageRequest
+from authentik_client.models.patched_authenticator_sms_stage_request import PatchedAuthenticatorSMSStageRequest as PatchedAuthenticatorSMSStageRequest
+from authentik_client.models.patched_authenticator_static_stage_request import PatchedAuthenticatorStaticStageRequest as PatchedAuthenticatorStaticStageRequest
+from authentik_client.models.patched_authenticator_totp_stage_request import PatchedAuthenticatorTOTPStageRequest as PatchedAuthenticatorTOTPStageRequest
+from authentik_client.models.patched_authenticator_validate_stage_request import PatchedAuthenticatorValidateStageRequest as PatchedAuthenticatorValidateStageRequest
+from authentik_client.models.patched_authenticator_web_authn_stage_request import PatchedAuthenticatorWebAuthnStageRequest as PatchedAuthenticatorWebAuthnStageRequest
+from authentik_client.models.patched_blueprint_instance_request import PatchedBlueprintInstanceRequest as PatchedBlueprintInstanceRequest
+from authentik_client.models.patched_brand_request import PatchedBrandRequest as PatchedBrandRequest
+from authentik_client.models.patched_captcha_stage_request import PatchedCaptchaStageRequest as PatchedCaptchaStageRequest
+from authentik_client.models.patched_certificate_key_pair_request import PatchedCertificateKeyPairRequest as PatchedCertificateKeyPairRequest
+from authentik_client.models.patched_connection_token_request import PatchedConnectionTokenRequest as PatchedConnectionTokenRequest
+from authentik_client.models.patched_consent_stage_request import PatchedConsentStageRequest as PatchedConsentStageRequest
+from authentik_client.models.patched_deny_stage_request import PatchedDenyStageRequest as PatchedDenyStageRequest
+from authentik_client.models.patched_device_access_group_request import PatchedDeviceAccessGroupRequest as PatchedDeviceAccessGroupRequest
+from authentik_client.models.patched_device_user_binding_request import PatchedDeviceUserBindingRequest as PatchedDeviceUserBindingRequest
+from authentik_client.models.patched_docker_service_connection_request import PatchedDockerServiceConnectionRequest as PatchedDockerServiceConnectionRequest
+from authentik_client.models.patched_domain_request import PatchedDomainRequest as PatchedDomainRequest
+from authentik_client.models.patched_dummy_policy_request import PatchedDummyPolicyRequest as PatchedDummyPolicyRequest
+from authentik_client.models.patched_dummy_stage_request import PatchedDummyStageRequest as PatchedDummyStageRequest
+from authentik_client.models.patched_duo_device_request import PatchedDuoDeviceRequest as PatchedDuoDeviceRequest
+from authentik_client.models.patched_email_device_request import PatchedEmailDeviceRequest as PatchedEmailDeviceRequest
+from authentik_client.models.patched_email_stage_request import PatchedEmailStageRequest as PatchedEmailStageRequest
+from authentik_client.models.patched_endpoint_device_request import PatchedEndpointDeviceRequest as PatchedEndpointDeviceRequest
+from authentik_client.models.patched_endpoint_request import PatchedEndpointRequest as PatchedEndpointRequest
+from authentik_client.models.patched_endpoint_stage_request import PatchedEndpointStageRequest as PatchedEndpointStageRequest
+from authentik_client.models.patched_enrollment_token_request import PatchedEnrollmentTokenRequest as PatchedEnrollmentTokenRequest
+from authentik_client.models.patched_event_matcher_policy_request import PatchedEventMatcherPolicyRequest as PatchedEventMatcherPolicyRequest
+from authentik_client.models.patched_event_request import PatchedEventRequest as PatchedEventRequest
+from authentik_client.models.patched_expression_policy_request import PatchedExpressionPolicyRequest as PatchedExpressionPolicyRequest
+from authentik_client.models.patched_fleet_connector_request import PatchedFleetConnectorRequest as PatchedFleetConnectorRequest
+from authentik_client.models.patched_flow_request import PatchedFlowRequest as PatchedFlowRequest
+from authentik_client.models.patched_flow_stage_binding_request import PatchedFlowStageBindingRequest as PatchedFlowStageBindingRequest
+from authentik_client.models.patched_geo_ip_policy_request import PatchedGeoIPPolicyRequest as PatchedGeoIPPolicyRequest
+from authentik_client.models.patched_google_chrome_connector_request import PatchedGoogleChromeConnectorRequest as PatchedGoogleChromeConnectorRequest
+from authentik_client.models.patched_google_endpoint_device_request import PatchedGoogleEndpointDeviceRequest as PatchedGoogleEndpointDeviceRequest
+from authentik_client.models.patched_google_workspace_provider_mapping_request import PatchedGoogleWorkspaceProviderMappingRequest as PatchedGoogleWorkspaceProviderMappingRequest
+from authentik_client.models.patched_google_workspace_provider_request import PatchedGoogleWorkspaceProviderRequest as PatchedGoogleWorkspaceProviderRequest
+from authentik_client.models.patched_group_kerberos_source_connection_request import PatchedGroupKerberosSourceConnectionRequest as PatchedGroupKerberosSourceConnectionRequest
+from authentik_client.models.patched_group_ldap_source_connection_request import PatchedGroupLDAPSourceConnectionRequest as PatchedGroupLDAPSourceConnectionRequest
+from authentik_client.models.patched_group_o_auth_source_connection_request import PatchedGroupOAuthSourceConnectionRequest as PatchedGroupOAuthSourceConnectionRequest
+from authentik_client.models.patched_group_plex_source_connection_request import PatchedGroupPlexSourceConnectionRequest as PatchedGroupPlexSourceConnectionRequest
+from authentik_client.models.patched_group_request import PatchedGroupRequest as PatchedGroupRequest
+from authentik_client.models.patched_group_saml_source_connection_request import PatchedGroupSAMLSourceConnectionRequest as PatchedGroupSAMLSourceConnectionRequest
+from authentik_client.models.patched_group_source_connection_request import PatchedGroupSourceConnectionRequest as PatchedGroupSourceConnectionRequest
+from authentik_client.models.patched_group_telegram_source_connection_request import PatchedGroupTelegramSourceConnectionRequest as PatchedGroupTelegramSourceConnectionRequest
+from authentik_client.models.patched_identification_stage_request import PatchedIdentificationStageRequest as PatchedIdentificationStageRequest
+from authentik_client.models.patched_initial_permissions_request import PatchedInitialPermissionsRequest as PatchedInitialPermissionsRequest
+from authentik_client.models.patched_invitation_request import PatchedInvitationRequest as PatchedInvitationRequest
+from authentik_client.models.patched_invitation_stage_request import PatchedInvitationStageRequest as PatchedInvitationStageRequest
+from authentik_client.models.patched_kerberos_source_property_mapping_request import PatchedKerberosSourcePropertyMappingRequest as PatchedKerberosSourcePropertyMappingRequest
+from authentik_client.models.patched_kerberos_source_request import PatchedKerberosSourceRequest as PatchedKerberosSourceRequest
+from authentik_client.models.patched_kubernetes_service_connection_request import PatchedKubernetesServiceConnectionRequest as PatchedKubernetesServiceConnectionRequest
+from authentik_client.models.patched_ldap_provider_request import PatchedLDAPProviderRequest as PatchedLDAPProviderRequest
+from authentik_client.models.patched_ldap_source_property_mapping_request import PatchedLDAPSourcePropertyMappingRequest as PatchedLDAPSourcePropertyMappingRequest
+from authentik_client.models.patched_ldap_source_request import PatchedLDAPSourceRequest as PatchedLDAPSourceRequest
+from authentik_client.models.patched_license_request import PatchedLicenseRequest as PatchedLicenseRequest
+from authentik_client.models.patched_lifecycle_rule_request import PatchedLifecycleRuleRequest as PatchedLifecycleRuleRequest
+from authentik_client.models.patched_microsoft_entra_provider_mapping_request import PatchedMicrosoftEntraProviderMappingRequest as PatchedMicrosoftEntraProviderMappingRequest
+from authentik_client.models.patched_microsoft_entra_provider_request import PatchedMicrosoftEntraProviderRequest as PatchedMicrosoftEntraProviderRequest
+from authentik_client.models.patched_mutual_tls_stage_request import PatchedMutualTLSStageRequest as PatchedMutualTLSStageRequest
+from authentik_client.models.patched_notification_request import PatchedNotificationRequest as PatchedNotificationRequest
+from authentik_client.models.patched_notification_rule_request import PatchedNotificationRuleRequest as PatchedNotificationRuleRequest
+from authentik_client.models.patched_notification_transport_request import PatchedNotificationTransportRequest as PatchedNotificationTransportRequest
+from authentik_client.models.patched_notification_webhook_mapping_request import PatchedNotificationWebhookMappingRequest as PatchedNotificationWebhookMappingRequest
+from authentik_client.models.patched_o_auth2_provider_request import PatchedOAuth2ProviderRequest as PatchedOAuth2ProviderRequest
+from authentik_client.models.patched_o_auth_source_property_mapping_request import PatchedOAuthSourcePropertyMappingRequest as PatchedOAuthSourcePropertyMappingRequest
+from authentik_client.models.patched_o_auth_source_request import PatchedOAuthSourceRequest as PatchedOAuthSourceRequest
+from authentik_client.models.patched_outpost_request import PatchedOutpostRequest as PatchedOutpostRequest
+from authentik_client.models.patched_password_expiry_policy_request import PatchedPasswordExpiryPolicyRequest as PatchedPasswordExpiryPolicyRequest
+from authentik_client.models.patched_password_policy_request import PatchedPasswordPolicyRequest as PatchedPasswordPolicyRequest
+from authentik_client.models.patched_password_stage_request import PatchedPasswordStageRequest as PatchedPasswordStageRequest
+from authentik_client.models.patched_permission_assign_request import PatchedPermissionAssignRequest as PatchedPermissionAssignRequest
+from authentik_client.models.patched_plex_source_property_mapping_request import PatchedPlexSourcePropertyMappingRequest as PatchedPlexSourcePropertyMappingRequest
+from authentik_client.models.patched_plex_source_request import PatchedPlexSourceRequest as PatchedPlexSourceRequest
+from authentik_client.models.patched_policy_binding_request import PatchedPolicyBindingRequest as PatchedPolicyBindingRequest
+from authentik_client.models.patched_prompt_request import PatchedPromptRequest as PatchedPromptRequest
+from authentik_client.models.patched_prompt_stage_request import PatchedPromptStageRequest as PatchedPromptStageRequest
+from authentik_client.models.patched_proxy_provider_request import PatchedProxyProviderRequest as PatchedProxyProviderRequest
+from authentik_client.models.patched_rac_property_mapping_request import PatchedRACPropertyMappingRequest as PatchedRACPropertyMappingRequest
+from authentik_client.models.patched_rac_provider_request import PatchedRACProviderRequest as PatchedRACProviderRequest
+from authentik_client.models.patched_radius_provider_property_mapping_request import PatchedRadiusProviderPropertyMappingRequest as PatchedRadiusProviderPropertyMappingRequest
+from authentik_client.models.patched_radius_provider_request import PatchedRadiusProviderRequest as PatchedRadiusProviderRequest
+from authentik_client.models.patched_redirect_stage_request import PatchedRedirectStageRequest as PatchedRedirectStageRequest
+from authentik_client.models.patched_reputation_policy_request import PatchedReputationPolicyRequest as PatchedReputationPolicyRequest
+from authentik_client.models.patched_role_request import PatchedRoleRequest as PatchedRoleRequest
+from authentik_client.models.patched_saml_property_mapping_request import PatchedSAMLPropertyMappingRequest as PatchedSAMLPropertyMappingRequest
+from authentik_client.models.patched_saml_provider_request import PatchedSAMLProviderRequest as PatchedSAMLProviderRequest
+from authentik_client.models.patched_saml_source_property_mapping_request import PatchedSAMLSourcePropertyMappingRequest as PatchedSAMLSourcePropertyMappingRequest
+from authentik_client.models.patched_saml_source_request import PatchedSAMLSourceRequest as PatchedSAMLSourceRequest
+from authentik_client.models.patched_scim_mapping_request import PatchedSCIMMappingRequest as PatchedSCIMMappingRequest
+from authentik_client.models.patched_scim_provider_request import PatchedSCIMProviderRequest as PatchedSCIMProviderRequest
+from authentik_client.models.patched_scim_source_group_request import PatchedSCIMSourceGroupRequest as PatchedSCIMSourceGroupRequest
+from authentik_client.models.patched_scim_source_property_mapping_request import PatchedSCIMSourcePropertyMappingRequest as PatchedSCIMSourcePropertyMappingRequest
+from authentik_client.models.patched_scim_source_request import PatchedSCIMSourceRequest as PatchedSCIMSourceRequest
+from authentik_client.models.patched_scim_source_user_request import PatchedSCIMSourceUserRequest as PatchedSCIMSourceUserRequest
+from authentik_client.models.patched_sms_device_request import PatchedSMSDeviceRequest as PatchedSMSDeviceRequest
+from authentik_client.models.patched_ssf_provider_request import PatchedSSFProviderRequest as PatchedSSFProviderRequest
+from authentik_client.models.patched_schedule_request import PatchedScheduleRequest as PatchedScheduleRequest
+from authentik_client.models.patched_scope_mapping_request import PatchedScopeMappingRequest as PatchedScopeMappingRequest
+from authentik_client.models.patched_settings_request import PatchedSettingsRequest as PatchedSettingsRequest
+from authentik_client.models.patched_settings_request_flags import PatchedSettingsRequestFlags as PatchedSettingsRequestFlags
+from authentik_client.models.patched_source_stage_request import PatchedSourceStageRequest as PatchedSourceStageRequest
+from authentik_client.models.patched_static_device_request import PatchedStaticDeviceRequest as PatchedStaticDeviceRequest
+from authentik_client.models.patched_totp_device_request import PatchedTOTPDeviceRequest as PatchedTOTPDeviceRequest
+from authentik_client.models.patched_telegram_source_property_mapping_request import PatchedTelegramSourcePropertyMappingRequest as PatchedTelegramSourcePropertyMappingRequest
+from authentik_client.models.patched_telegram_source_request import PatchedTelegramSourceRequest as PatchedTelegramSourceRequest
+from authentik_client.models.patched_tenant_request import PatchedTenantRequest as PatchedTenantRequest
+from authentik_client.models.patched_token_request import PatchedTokenRequest as PatchedTokenRequest
+from authentik_client.models.patched_unique_password_policy_request import PatchedUniquePasswordPolicyRequest as PatchedUniquePasswordPolicyRequest
+from authentik_client.models.patched_user_delete_stage_request import PatchedUserDeleteStageRequest as PatchedUserDeleteStageRequest
+from authentik_client.models.patched_user_kerberos_source_connection_request import PatchedUserKerberosSourceConnectionRequest as PatchedUserKerberosSourceConnectionRequest
+from authentik_client.models.patched_user_ldap_source_connection_request import PatchedUserLDAPSourceConnectionRequest as PatchedUserLDAPSourceConnectionRequest
+from authentik_client.models.patched_user_login_stage_request import PatchedUserLoginStageRequest as PatchedUserLoginStageRequest
+from authentik_client.models.patched_user_logout_stage_request import PatchedUserLogoutStageRequest as PatchedUserLogoutStageRequest
+from authentik_client.models.patched_user_o_auth_source_connection_request import PatchedUserOAuthSourceConnectionRequest as PatchedUserOAuthSourceConnectionRequest
+from authentik_client.models.patched_user_plex_source_connection_request import PatchedUserPlexSourceConnectionRequest as PatchedUserPlexSourceConnectionRequest
+from authentik_client.models.patched_user_request import PatchedUserRequest as PatchedUserRequest
+from authentik_client.models.patched_user_saml_source_connection_request import PatchedUserSAMLSourceConnectionRequest as PatchedUserSAMLSourceConnectionRequest
+from authentik_client.models.patched_user_source_connection_request import PatchedUserSourceConnectionRequest as PatchedUserSourceConnectionRequest
+from authentik_client.models.patched_user_telegram_source_connection_request import PatchedUserTelegramSourceConnectionRequest as PatchedUserTelegramSourceConnectionRequest
+from authentik_client.models.patched_user_write_stage_request import PatchedUserWriteStageRequest as PatchedUserWriteStageRequest
+from authentik_client.models.patched_ws_federation_provider_request import PatchedWSFederationProviderRequest as PatchedWSFederationProviderRequest
+from authentik_client.models.patched_web_authn_device_request import PatchedWebAuthnDeviceRequest as PatchedWebAuthnDeviceRequest
+from authentik_client.models.permission import Permission as Permission
+from authentik_client.models.permission_assign_request import PermissionAssignRequest as PermissionAssignRequest
+from authentik_client.models.permission_assign_result import PermissionAssignResult as PermissionAssignResult
+from authentik_client.models.plex_authentication_challenge import PlexAuthenticationChallenge as PlexAuthenticationChallenge
+from authentik_client.models.plex_authentication_challenge_response_request import PlexAuthenticationChallengeResponseRequest as PlexAuthenticationChallengeResponseRequest
+from authentik_client.models.plex_source import PlexSource as PlexSource
+from authentik_client.models.plex_source_property_mapping import PlexSourcePropertyMapping as PlexSourcePropertyMapping
+from authentik_client.models.plex_source_property_mapping_request import PlexSourcePropertyMappingRequest as PlexSourcePropertyMappingRequest
+from authentik_client.models.plex_source_request import PlexSourceRequest as PlexSourceRequest
+from authentik_client.models.plex_token_redeem_request import PlexTokenRedeemRequest as PlexTokenRedeemRequest
+from authentik_client.models.policy import Policy as Policy
+from authentik_client.models.policy_binding import PolicyBinding as PolicyBinding
+from authentik_client.models.policy_binding_request import PolicyBindingRequest as PolicyBindingRequest
+from authentik_client.models.policy_engine_mode import PolicyEngineMode as PolicyEngineMode
+from authentik_client.models.policy_test_request import PolicyTestRequest as PolicyTestRequest
+from authentik_client.models.policy_test_result import PolicyTestResult as PolicyTestResult
+from authentik_client.models.process import Process as Process
+from authentik_client.models.process_request import ProcessRequest as ProcessRequest
+from authentik_client.models.prompt import Prompt as Prompt
+from authentik_client.models.prompt_challenge import PromptChallenge as PromptChallenge
+from authentik_client.models.prompt_challenge_response_request import PromptChallengeResponseRequest as PromptChallengeResponseRequest
+from authentik_client.models.prompt_choice import PromptChoice as PromptChoice
+from authentik_client.models.prompt_request import PromptRequest as PromptRequest
+from authentik_client.models.prompt_stage import PromptStage as PromptStage
+from authentik_client.models.prompt_stage_request import PromptStageRequest as PromptStageRequest
+from authentik_client.models.prompt_type_enum import PromptTypeEnum as PromptTypeEnum
+from authentik_client.models.property_mapping import PropertyMapping as PropertyMapping
+from authentik_client.models.property_mapping_preview import PropertyMappingPreview as PropertyMappingPreview
+from authentik_client.models.property_mapping_test_request import PropertyMappingTestRequest as PropertyMappingTestRequest
+from authentik_client.models.property_mapping_test_result import PropertyMappingTestResult as PropertyMappingTestResult
+from authentik_client.models.protocol_enum import ProtocolEnum as ProtocolEnum
+from authentik_client.models.provider import Provider as Provider
+from authentik_client.models.provider_enum import ProviderEnum as ProviderEnum
+from authentik_client.models.provider_model_enum import ProviderModelEnum as ProviderModelEnum
+from authentik_client.models.provider_type_enum import ProviderTypeEnum as ProviderTypeEnum
+from authentik_client.models.proxy_mode import ProxyMode as ProxyMode
+from authentik_client.models.proxy_outpost_config import ProxyOutpostConfig as ProxyOutpostConfig
+from authentik_client.models.proxy_provider import ProxyProvider as ProxyProvider
+from authentik_client.models.proxy_provider_request import ProxyProviderRequest as ProxyProviderRequest
+from authentik_client.models.rac_property_mapping import RACPropertyMapping as RACPropertyMapping
+from authentik_client.models.rac_property_mapping_request import RACPropertyMappingRequest as RACPropertyMappingRequest
+from authentik_client.models.rac_provider import RACProvider as RACProvider
+from authentik_client.models.rac_provider_request import RACProviderRequest as RACProviderRequest
+from authentik_client.models.radius_check_access import RadiusCheckAccess as RadiusCheckAccess
+from authentik_client.models.radius_outpost_config import RadiusOutpostConfig as RadiusOutpostConfig
+from authentik_client.models.radius_provider import RadiusProvider as RadiusProvider
+from authentik_client.models.radius_provider_property_mapping import RadiusProviderPropertyMapping as RadiusProviderPropertyMapping
+from authentik_client.models.radius_provider_property_mapping_request import RadiusProviderPropertyMappingRequest as RadiusProviderPropertyMappingRequest
+from authentik_client.models.radius_provider_request import RadiusProviderRequest as RadiusProviderRequest
+from authentik_client.models.redirect_challenge import RedirectChallenge as RedirectChallenge
+from authentik_client.models.redirect_challenge_response_request import RedirectChallengeResponseRequest as RedirectChallengeResponseRequest
+from authentik_client.models.redirect_stage import RedirectStage as RedirectStage
+from authentik_client.models.redirect_stage_mode_enum import RedirectStageModeEnum as RedirectStageModeEnum
+from authentik_client.models.redirect_stage_request import RedirectStageRequest as RedirectStageRequest
+from authentik_client.models.redirect_uri import RedirectURI as RedirectURI
+from authentik_client.models.redirect_uri_request import RedirectURIRequest as RedirectURIRequest
+from authentik_client.models.redirect_uri_type_enum import RedirectURITypeEnum as RedirectURITypeEnum
+from authentik_client.models.related_group import RelatedGroup as RelatedGroup
+from authentik_client.models.related_rule import RelatedRule as RelatedRule
+from authentik_client.models.reputation import Reputation as Reputation
+from authentik_client.models.reputation_policy import ReputationPolicy as ReputationPolicy
+from authentik_client.models.reputation_policy_request import ReputationPolicyRequest as ReputationPolicyRequest
+from authentik_client.models.review import Review as Review
+from authentik_client.models.review_request import ReviewRequest as ReviewRequest
+from authentik_client.models.reviewer_group import ReviewerGroup as ReviewerGroup
+from authentik_client.models.reviewer_user import ReviewerUser as ReviewerUser
+from authentik_client.models.role import Role as Role
+from authentik_client.models.role_assigned_object_permission import RoleAssignedObjectPermission as RoleAssignedObjectPermission
+from authentik_client.models.role_model_permission import RoleModelPermission as RoleModelPermission
+from authentik_client.models.role_object_permission import RoleObjectPermission as RoleObjectPermission
+from authentik_client.models.role_request import RoleRequest as RoleRequest
+from authentik_client.models.saml_bindings_enum import SAMLBindingsEnum as SAMLBindingsEnum
+from authentik_client.models.saml_logout_methods import SAMLLogoutMethods as SAMLLogoutMethods
+from authentik_client.models.saml_metadata import SAMLMetadata as SAMLMetadata
+from authentik_client.models.saml_name_id_policy_enum import SAMLNameIDPolicyEnum as SAMLNameIDPolicyEnum
+from authentik_client.models.saml_property_mapping import SAMLPropertyMapping as SAMLPropertyMapping
+from authentik_client.models.saml_property_mapping_request import SAMLPropertyMappingRequest as SAMLPropertyMappingRequest
+from authentik_client.models.saml_provider import SAMLProvider as SAMLProvider
+from authentik_client.models.saml_provider_request import SAMLProviderRequest as SAMLProviderRequest
+from authentik_client.models.saml_source import SAMLSource as SAMLSource
+from authentik_client.models.saml_source_property_mapping import SAMLSourcePropertyMapping as SAMLSourcePropertyMapping
+from authentik_client.models.saml_source_property_mapping_request import SAMLSourcePropertyMappingRequest as SAMLSourcePropertyMappingRequest
+from authentik_client.models.saml_source_request import SAMLSourceRequest as SAMLSourceRequest
+from authentik_client.models.scim_authentication_mode_enum import SCIMAuthenticationModeEnum as SCIMAuthenticationModeEnum
+from authentik_client.models.scim_mapping import SCIMMapping as SCIMMapping
+from authentik_client.models.scim_mapping_request import SCIMMappingRequest as SCIMMappingRequest
+from authentik_client.models.scim_provider import SCIMProvider as SCIMProvider
+from authentik_client.models.scim_provider_group import SCIMProviderGroup as SCIMProviderGroup
+from authentik_client.models.scim_provider_group_request import SCIMProviderGroupRequest as SCIMProviderGroupRequest
+from authentik_client.models.scim_provider_request import SCIMProviderRequest as SCIMProviderRequest
+from authentik_client.models.scim_provider_user import SCIMProviderUser as SCIMProviderUser
+from authentik_client.models.scim_provider_user_request import SCIMProviderUserRequest as SCIMProviderUserRequest
+from authentik_client.models.scim_source import SCIMSource as SCIMSource
+from authentik_client.models.scim_source_group import SCIMSourceGroup as SCIMSourceGroup
+from authentik_client.models.scim_source_group_request import SCIMSourceGroupRequest as SCIMSourceGroupRequest
+from authentik_client.models.scim_source_property_mapping import SCIMSourcePropertyMapping as SCIMSourcePropertyMapping
+from authentik_client.models.scim_source_property_mapping_request import SCIMSourcePropertyMappingRequest as SCIMSourcePropertyMappingRequest
+from authentik_client.models.scim_source_request import SCIMSourceRequest as SCIMSourceRequest
+from authentik_client.models.scim_source_user import SCIMSourceUser as SCIMSourceUser
+from authentik_client.models.scim_source_user_request import SCIMSourceUserRequest as SCIMSourceUserRequest
+from authentik_client.models.sms_device import SMSDevice as SMSDevice
+from authentik_client.models.sms_device_request import SMSDeviceRequest as SMSDeviceRequest
+from authentik_client.models.ssf_provider import SSFProvider as SSFProvider
+from authentik_client.models.ssf_provider_request import SSFProviderRequest as SSFProviderRequest
+from authentik_client.models.ssf_stream import SSFStream as SSFStream
+from authentik_client.models.ssf_stream_status_enum import SSFStreamStatusEnum as SSFStreamStatusEnum
+from authentik_client.models.schedule import Schedule as Schedule
+from authentik_client.models.schedule_request import ScheduleRequest as ScheduleRequest
+from authentik_client.models.scope_mapping import ScopeMapping as ScopeMapping
+from authentik_client.models.scope_mapping_request import ScopeMappingRequest as ScopeMappingRequest
+from authentik_client.models.selectable_stage import SelectableStage as SelectableStage
+from authentik_client.models.service_connection import ServiceConnection as ServiceConnection
+from authentik_client.models.service_connection_state import ServiceConnectionState as ServiceConnectionState
+from authentik_client.models.session_end_challenge import SessionEndChallenge as SessionEndChallenge
+from authentik_client.models.session_user import SessionUser as SessionUser
+from authentik_client.models.settings import Settings as Settings
+from authentik_client.models.settings_request import SettingsRequest as SettingsRequest
+from authentik_client.models.severity_enum import SeverityEnum as SeverityEnum
+from authentik_client.models.shell_challenge import ShellChallenge as ShellChallenge
+from authentik_client.models.signature_algorithm_enum import SignatureAlgorithmEnum as SignatureAlgorithmEnum
+from authentik_client.models.software import Software as Software
+from authentik_client.models.software_request import SoftwareRequest as SoftwareRequest
+from authentik_client.models.source import Source as Source
+from authentik_client.models.source_stage import SourceStage as SourceStage
+from authentik_client.models.source_stage_request import SourceStageRequest as SourceStageRequest
+from authentik_client.models.source_type import SourceType as SourceType
+from authentik_client.models.stage import Stage as Stage
+from authentik_client.models.stage_mode_enum import StageModeEnum as StageModeEnum
+from authentik_client.models.stage_prompt import StagePrompt as StagePrompt
+from authentik_client.models.static_device import StaticDevice as StaticDevice
+from authentik_client.models.static_device_request import StaticDeviceRequest as StaticDeviceRequest
+from authentik_client.models.static_device_token import StaticDeviceToken as StaticDeviceToken
+from authentik_client.models.sub_mode_enum import SubModeEnum as SubModeEnum
+from authentik_client.models.sync_object_model_enum import SyncObjectModelEnum as SyncObjectModelEnum
+from authentik_client.models.sync_object_request import SyncObjectRequest as SyncObjectRequest
+from authentik_client.models.sync_object_result import SyncObjectResult as SyncObjectResult
+from authentik_client.models.sync_outgoing_trigger_mode_enum import SyncOutgoingTriggerModeEnum as SyncOutgoingTriggerModeEnum
+from authentik_client.models.sync_status import SyncStatus as SyncStatus
+from authentik_client.models.system_info import SystemInfo as SystemInfo
+from authentik_client.models.system_info_runtime import SystemInfoRuntime as SystemInfoRuntime
+from authentik_client.models.totp_device import TOTPDevice as TOTPDevice
+from authentik_client.models.totp_device_request import TOTPDeviceRequest as TOTPDeviceRequest
+from authentik_client.models.task import Task as Task
+from authentik_client.models.task_aggregated_status_enum import TaskAggregatedStatusEnum as TaskAggregatedStatusEnum
+from authentik_client.models.task_status_enum import TaskStatusEnum as TaskStatusEnum
+from authentik_client.models.telegram_auth_request import TelegramAuthRequest as TelegramAuthRequest
+from authentik_client.models.telegram_challenge_response_request import TelegramChallengeResponseRequest as TelegramChallengeResponseRequest
+from authentik_client.models.telegram_login_challenge import TelegramLoginChallenge as TelegramLoginChallenge
+from authentik_client.models.telegram_source import TelegramSource as TelegramSource
+from authentik_client.models.telegram_source_property_mapping import TelegramSourcePropertyMapping as TelegramSourcePropertyMapping
+from authentik_client.models.telegram_source_property_mapping_request import TelegramSourcePropertyMappingRequest as TelegramSourcePropertyMappingRequest
+from authentik_client.models.telegram_source_request import TelegramSourceRequest as TelegramSourceRequest
+from authentik_client.models.tenant import Tenant as Tenant
+from authentik_client.models.tenant_admin_group_request_request import TenantAdminGroupRequestRequest as TenantAdminGroupRequestRequest
+from authentik_client.models.tenant_recovery_key_request_request import TenantRecoveryKeyRequestRequest as TenantRecoveryKeyRequestRequest
+from authentik_client.models.tenant_recovery_key_response import TenantRecoveryKeyResponse as TenantRecoveryKeyResponse
+from authentik_client.models.tenant_request import TenantRequest as TenantRequest
+from authentik_client.models.themed_urls import ThemedUrls as ThemedUrls
+from authentik_client.models.token import Token as Token
+from authentik_client.models.token_model import TokenModel as TokenModel
+from authentik_client.models.token_request import TokenRequest as TokenRequest
+from authentik_client.models.token_set_key_request import TokenSetKeyRequest as TokenSetKeyRequest
+from authentik_client.models.token_view import TokenView as TokenView
+from authentik_client.models.transaction_application_request import TransactionApplicationRequest as TransactionApplicationRequest
+from authentik_client.models.transaction_application_response import TransactionApplicationResponse as TransactionApplicationResponse
+from authentik_client.models.transaction_policy_binding_request import TransactionPolicyBindingRequest as TransactionPolicyBindingRequest
+from authentik_client.models.transport_mode_enum import TransportModeEnum as TransportModeEnum
+from authentik_client.models.type_create import TypeCreate as TypeCreate
+from authentik_client.models.ui_theme_enum import UiThemeEnum as UiThemeEnum
+from authentik_client.models.unique_password_policy import UniquePasswordPolicy as UniquePasswordPolicy
+from authentik_client.models.unique_password_policy_request import UniquePasswordPolicyRequest as UniquePasswordPolicyRequest
+from authentik_client.models.usage_enum import UsageEnum as UsageEnum
+from authentik_client.models.used_by import UsedBy as UsedBy
+from authentik_client.models.used_by_action_enum import UsedByActionEnum as UsedByActionEnum
+from authentik_client.models.user import User as User
+from authentik_client.models.user_account_lockdown_request import UserAccountLockdownRequest as UserAccountLockdownRequest
+from authentik_client.models.user_account_request import UserAccountRequest as UserAccountRequest
+from authentik_client.models.user_account_serializer_for_role_request import UserAccountSerializerForRoleRequest as UserAccountSerializerForRoleRequest
+from authentik_client.models.user_attribute_enum import UserAttributeEnum as UserAttributeEnum
+from authentik_client.models.user_consent import UserConsent as UserConsent
+from authentik_client.models.user_creation_mode_enum import UserCreationModeEnum as UserCreationModeEnum
+from authentik_client.models.user_delete_stage import UserDeleteStage as UserDeleteStage
+from authentik_client.models.user_delete_stage_request import UserDeleteStageRequest as UserDeleteStageRequest
+from authentik_client.models.user_fields_enum import UserFieldsEnum as UserFieldsEnum
+from authentik_client.models.user_kerberos_source_connection import UserKerberosSourceConnection as UserKerberosSourceConnection
+from authentik_client.models.user_kerberos_source_connection_request import UserKerberosSourceConnectionRequest as UserKerberosSourceConnectionRequest
+from authentik_client.models.user_ldap_source_connection import UserLDAPSourceConnection as UserLDAPSourceConnection
+from authentik_client.models.user_ldap_source_connection_request import UserLDAPSourceConnectionRequest as UserLDAPSourceConnectionRequest
+from authentik_client.models.user_login_challenge import UserLoginChallenge as UserLoginChallenge
+from authentik_client.models.user_login_challenge_response_request import UserLoginChallengeResponseRequest as UserLoginChallengeResponseRequest
+from authentik_client.models.user_login_stage import UserLoginStage as UserLoginStage
+from authentik_client.models.user_login_stage_request import UserLoginStageRequest as UserLoginStageRequest
+from authentik_client.models.user_logout_stage import UserLogoutStage as UserLogoutStage
+from authentik_client.models.user_logout_stage_request import UserLogoutStageRequest as UserLogoutStageRequest
+from authentik_client.models.user_matching_mode_enum import UserMatchingModeEnum as UserMatchingModeEnum
+from authentik_client.models.user_o_auth_source_connection import UserOAuthSourceConnection as UserOAuthSourceConnection
+from authentik_client.models.user_o_auth_source_connection_request import UserOAuthSourceConnectionRequest as UserOAuthSourceConnectionRequest
+from authentik_client.models.user_password_hash_set_request import UserPasswordHashSetRequest as UserPasswordHashSetRequest
+from authentik_client.models.user_password_set_request import UserPasswordSetRequest as UserPasswordSetRequest
+from authentik_client.models.user_path import UserPath as UserPath
+from authentik_client.models.user_plex_source_connection import UserPlexSourceConnection as UserPlexSourceConnection
+from authentik_client.models.user_plex_source_connection_request import UserPlexSourceConnectionRequest as UserPlexSourceConnectionRequest
+from authentik_client.models.user_recovery_email_request import UserRecoveryEmailRequest as UserRecoveryEmailRequest
+from authentik_client.models.user_recovery_link_request import UserRecoveryLinkRequest as UserRecoveryLinkRequest
+from authentik_client.models.user_request import UserRequest as UserRequest
+from authentik_client.models.user_saml_source_connection import UserSAMLSourceConnection as UserSAMLSourceConnection
+from authentik_client.models.user_saml_source_connection_request import UserSAMLSourceConnectionRequest as UserSAMLSourceConnectionRequest
+from authentik_client.models.user_self import UserSelf as UserSelf
+from authentik_client.models.user_self_groups import UserSelfGroups as UserSelfGroups
+from authentik_client.models.user_self_roles import UserSelfRoles as UserSelfRoles
+from authentik_client.models.user_service_account_request import UserServiceAccountRequest as UserServiceAccountRequest
+from authentik_client.models.user_service_account_response import UserServiceAccountResponse as UserServiceAccountResponse
+from authentik_client.models.user_setting import UserSetting as UserSetting
+from authentik_client.models.user_source_connection import UserSourceConnection as UserSourceConnection
+from authentik_client.models.user_source_connection_request import UserSourceConnectionRequest as UserSourceConnectionRequest
+from authentik_client.models.user_telegram_source_connection import UserTelegramSourceConnection as UserTelegramSourceConnection
+from authentik_client.models.user_telegram_source_connection_request import UserTelegramSourceConnectionRequest as UserTelegramSourceConnectionRequest
+from authentik_client.models.user_type_enum import UserTypeEnum as UserTypeEnum
+from authentik_client.models.user_verification_enum import UserVerificationEnum as UserVerificationEnum
+from authentik_client.models.user_write_stage import UserWriteStage as UserWriteStage
+from authentik_client.models.user_write_stage_request import UserWriteStageRequest as UserWriteStageRequest
+from authentik_client.models.validation_error import ValidationError as ValidationError
+from authentik_client.models.vendor_enum import VendorEnum as VendorEnum
+from authentik_client.models.version import Version as Version
+from authentik_client.models.version_history import VersionHistory as VersionHistory
+from authentik_client.models.ws_federation_provider import WSFederationProvider as WSFederationProvider
+from authentik_client.models.ws_federation_provider_request import WSFederationProviderRequest as WSFederationProviderRequest
+from authentik_client.models.web_authn_device import WebAuthnDevice as WebAuthnDevice
+from authentik_client.models.web_authn_device_request import WebAuthnDeviceRequest as WebAuthnDeviceRequest
+from authentik_client.models.web_authn_device_type import WebAuthnDeviceType as WebAuthnDeviceType
+from authentik_client.models.web_authn_hint_enum import WebAuthnHintEnum as WebAuthnHintEnum
+from authentik_client.models.worker import Worker as Worker
+
diff --git a/authentik_client/api/__init__.py b/authentik_client/api/__init__.py
new file mode 100644
index 000000000..3f63f4abf
--- /dev/null
+++ b/authentik_client/api/__init__.py
@@ -0,0 +1,29 @@
+# flake8: noqa
+
+# import apis into api package
+from authentik_client.api.admin_api import AdminApi
+from authentik_client.api.authenticators_api import AuthenticatorsApi
+from authentik_client.api.core_api import CoreApi
+from authentik_client.api.crypto_api import CryptoApi
+from authentik_client.api.endpoints_api import EndpointsApi
+from authentik_client.api.enterprise_api import EnterpriseApi
+from authentik_client.api.events_api import EventsApi
+from authentik_client.api.flows_api import FlowsApi
+from authentik_client.api.lifecycle_api import LifecycleApi
+from authentik_client.api.managed_api import ManagedApi
+from authentik_client.api.oauth2_api import Oauth2Api
+from authentik_client.api.outposts_api import OutpostsApi
+from authentik_client.api.policies_api import PoliciesApi
+from authentik_client.api.propertymappings_api import PropertymappingsApi
+from authentik_client.api.providers_api import ProvidersApi
+from authentik_client.api.rac_api import RacApi
+from authentik_client.api.rbac_api import RbacApi
+from authentik_client.api.reports_api import ReportsApi
+from authentik_client.api.root_api import RootApi
+from authentik_client.api.schema_api import SchemaApi
+from authentik_client.api.sources_api import SourcesApi
+from authentik_client.api.ssf_api import SsfApi
+from authentik_client.api.stages_api import StagesApi
+from authentik_client.api.tasks_api import TasksApi
+from authentik_client.api.tenants_api import TenantsApi
+
diff --git a/authentik_client/api/admin_api.py b/authentik_client/api/admin_api.py
new file mode 100644
index 000000000..83f6b48b2
--- /dev/null
+++ b/authentik_client/api/admin_api.py
@@ -0,0 +1,3871 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr
+from typing import Any, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+from authentik_client.models.app import App
+from authentik_client.models.file_list import FileList
+from authentik_client.models.patched_settings_request import PatchedSettingsRequest
+from authentik_client.models.settings import Settings
+from authentik_client.models.settings_request import SettingsRequest
+from authentik_client.models.system_info import SystemInfo
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.version import Version
+from authentik_client.models.version_history import VersionHistory
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class AdminApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def admin_apps_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[App]:
+ """admin_apps_list
+
+ Read-only view list all installed apps
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_apps_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[App]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_apps_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[App]]:
+ """admin_apps_list
+
+ Read-only view list all installed apps
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_apps_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[App]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_apps_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_apps_list
+
+ Read-only view list all installed apps
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_apps_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[App]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_apps_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/apps/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_file_create(
+ self,
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+ name: Optional[StrictStr] = None,
+ usage: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """admin_file_create
+
+ Upload file to storage backend.
+
+ :param file: (required)
+ :type file: bytes
+ :param name:
+ :type name: str
+ :param usage:
+ :type usage: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_create_serialize(
+ file=file,
+ name=name,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_file_create_with_http_info(
+ self,
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+ name: Optional[StrictStr] = None,
+ usage: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """admin_file_create
+
+ Upload file to storage backend.
+
+ :param file: (required)
+ :type file: bytes
+ :param name:
+ :type name: str
+ :param usage:
+ :type usage: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_create_serialize(
+ file=file,
+ name=name,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_file_create_without_preload_content(
+ self,
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+ name: Optional[StrictStr] = None,
+ usage: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_file_create
+
+ Upload file to storage backend.
+
+ :param file: (required)
+ :type file: bytes
+ :param name:
+ :type name: str
+ :param usage:
+ :type usage: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_create_serialize(
+ file=file,
+ name=name,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_file_create_serialize(
+ self,
+ file,
+ name,
+ usage,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ if file is not None:
+ _files['file'] = file
+ if name is not None:
+ _form_params.append(('name', name))
+ if usage is not None:
+ _form_params.append(('usage', usage))
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'multipart/form-data'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/admin/file/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_file_destroy(
+ self,
+ name: Optional[StrictStr] = None,
+ usage: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """admin_file_destroy
+
+ Delete file from storage backend.
+
+ :param name:
+ :type name: str
+ :param usage:
+ :type usage: UsageEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_destroy_serialize(
+ name=name,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_file_destroy_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ usage: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """admin_file_destroy
+
+ Delete file from storage backend.
+
+ :param name:
+ :type name: str
+ :param usage:
+ :type usage: UsageEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_destroy_serialize(
+ name=name,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_file_destroy_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ usage: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_file_destroy
+
+ Delete file from storage backend.
+
+ :param name:
+ :type name: str
+ :param usage:
+ :type usage: UsageEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_destroy_serialize(
+ name=name,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_file_destroy_serialize(
+ self,
+ name,
+ usage,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if usage is not None:
+
+ _query_params.append(('usage', usage.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/admin/file/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_file_list(
+ self,
+ manageable_only: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ usage: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[FileList]:
+ """admin_file_list
+
+ List files from storage backend.
+
+ :param manageable_only:
+ :type manageable_only: bool
+ :param search: A search term.
+ :type search: str
+ :param usage:
+ :type usage: UsageEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_list_serialize(
+ manageable_only=manageable_only,
+ search=search,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[FileList]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_file_list_with_http_info(
+ self,
+ manageable_only: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ usage: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[FileList]]:
+ """admin_file_list
+
+ List files from storage backend.
+
+ :param manageable_only:
+ :type manageable_only: bool
+ :param search: A search term.
+ :type search: str
+ :param usage:
+ :type usage: UsageEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_list_serialize(
+ manageable_only=manageable_only,
+ search=search,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[FileList]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_file_list_without_preload_content(
+ self,
+ manageable_only: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ usage: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_file_list
+
+ List files from storage backend.
+
+ :param manageable_only:
+ :type manageable_only: bool
+ :param search: A search term.
+ :type search: str
+ :param usage:
+ :type usage: UsageEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_list_serialize(
+ manageable_only=manageable_only,
+ search=search,
+ usage=usage,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[FileList]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_file_list_serialize(
+ self,
+ manageable_only,
+ search,
+ usage,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if manageable_only is not None:
+
+ _query_params.append(('manageable_only', manageable_only))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if usage is not None:
+
+ _query_params.append(('usage', usage.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/file/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_file_used_by_list(
+ self,
+ name: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """admin_file_used_by_list
+
+
+ :param name:
+ :type name: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_used_by_list_serialize(
+ name=name,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_file_used_by_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """admin_file_used_by_list
+
+
+ :param name:
+ :type name: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_used_by_list_serialize(
+ name=name,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_file_used_by_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_file_used_by_list
+
+
+ :param name:
+ :type name: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_file_used_by_list_serialize(
+ name=name,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_file_used_by_list_serialize(
+ self,
+ name,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/file/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_models_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[App]:
+ """admin_models_list
+
+ Read-only view list all installed models
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_models_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[App]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_models_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[App]]:
+ """admin_models_list
+
+ Read-only view list all installed models
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_models_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[App]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_models_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_models_list
+
+ Read-only view list all installed models
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_models_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[App]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_models_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/models/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_settings_partial_update(
+ self,
+ patched_settings_request: Optional[PatchedSettingsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Settings:
+ """admin_settings_partial_update
+
+ Settings view
+
+ :param patched_settings_request:
+ :type patched_settings_request: PatchedSettingsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_partial_update_serialize(
+ patched_settings_request=patched_settings_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_settings_partial_update_with_http_info(
+ self,
+ patched_settings_request: Optional[PatchedSettingsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Settings]:
+ """admin_settings_partial_update
+
+ Settings view
+
+ :param patched_settings_request:
+ :type patched_settings_request: PatchedSettingsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_partial_update_serialize(
+ patched_settings_request=patched_settings_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_settings_partial_update_without_preload_content(
+ self,
+ patched_settings_request: Optional[PatchedSettingsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_settings_partial_update
+
+ Settings view
+
+ :param patched_settings_request:
+ :type patched_settings_request: PatchedSettingsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_partial_update_serialize(
+ patched_settings_request=patched_settings_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_settings_partial_update_serialize(
+ self,
+ patched_settings_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_settings_request is not None:
+ _body_params = patched_settings_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/admin/settings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_settings_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Settings:
+ """admin_settings_retrieve
+
+ Settings view
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_settings_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Settings]:
+ """admin_settings_retrieve
+
+ Settings view
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_settings_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_settings_retrieve
+
+ Settings view
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_settings_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/settings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_settings_update(
+ self,
+ settings_request: SettingsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Settings:
+ """admin_settings_update
+
+ Settings view
+
+ :param settings_request: (required)
+ :type settings_request: SettingsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_update_serialize(
+ settings_request=settings_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_settings_update_with_http_info(
+ self,
+ settings_request: SettingsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Settings]:
+ """admin_settings_update
+
+ Settings view
+
+ :param settings_request: (required)
+ :type settings_request: SettingsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_update_serialize(
+ settings_request=settings_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_settings_update_without_preload_content(
+ self,
+ settings_request: SettingsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_settings_update
+
+ Settings view
+
+ :param settings_request: (required)
+ :type settings_request: SettingsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_settings_update_serialize(
+ settings_request=settings_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Settings",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_settings_update_serialize(
+ self,
+ settings_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if settings_request is not None:
+ _body_params = settings_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/admin/settings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_system_create(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SystemInfo:
+ """admin_system_create
+
+ Get system information.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_system_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SystemInfo",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_system_create_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SystemInfo]:
+ """admin_system_create
+
+ Get system information.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_system_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SystemInfo",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_system_create_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_system_create
+
+ Get system information.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_system_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SystemInfo",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_system_create_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/admin/system/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_system_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SystemInfo:
+ """admin_system_retrieve
+
+ Get system information.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_system_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SystemInfo",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_system_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SystemInfo]:
+ """admin_system_retrieve
+
+ Get system information.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_system_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SystemInfo",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_system_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_system_retrieve
+
+ Get system information.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_system_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SystemInfo",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_system_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/system/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_version_history_list(
+ self,
+ build: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ version: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[VersionHistory]:
+ """admin_version_history_list
+
+ VersionHistory Viewset
+
+ :param build:
+ :type build: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param version:
+ :type version: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_history_list_serialize(
+ build=build,
+ ordering=ordering,
+ search=search,
+ version=version,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[VersionHistory]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_version_history_list_with_http_info(
+ self,
+ build: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ version: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[VersionHistory]]:
+ """admin_version_history_list
+
+ VersionHistory Viewset
+
+ :param build:
+ :type build: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param version:
+ :type version: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_history_list_serialize(
+ build=build,
+ ordering=ordering,
+ search=search,
+ version=version,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[VersionHistory]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_version_history_list_without_preload_content(
+ self,
+ build: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ version: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_version_history_list
+
+ VersionHistory Viewset
+
+ :param build:
+ :type build: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param version:
+ :type version: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_history_list_serialize(
+ build=build,
+ ordering=ordering,
+ search=search,
+ version=version,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[VersionHistory]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_version_history_list_serialize(
+ self,
+ build,
+ ordering,
+ search,
+ version,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if build is not None:
+
+ _query_params.append(('build', build))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if version is not None:
+
+ _query_params.append(('version', version))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/version/history/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_version_history_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Version history.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> VersionHistory:
+ """admin_version_history_retrieve
+
+ VersionHistory Viewset
+
+ :param id: A unique integer value identifying this Version history. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_history_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "VersionHistory",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_version_history_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Version history.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[VersionHistory]:
+ """admin_version_history_retrieve
+
+ VersionHistory Viewset
+
+ :param id: A unique integer value identifying this Version history. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_history_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "VersionHistory",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_version_history_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Version history.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_version_history_retrieve
+
+ VersionHistory Viewset
+
+ :param id: A unique integer value identifying this Version history. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_history_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "VersionHistory",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_version_history_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/version/history/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def admin_version_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Version:
+ """admin_version_retrieve
+
+ Get running and latest version.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Version",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def admin_version_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Version]:
+ """admin_version_retrieve
+
+ Get running and latest version.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Version",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def admin_version_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """admin_version_retrieve
+
+ Get running and latest version.
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._admin_version_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Version",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _admin_version_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/admin/version/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/authenticators_api.py b/authentik_client/api/authenticators_api.py
new file mode 100644
index 000000000..aaf85288b
--- /dev/null
+++ b/authentik_client/api/authenticators_api.py
@@ -0,0 +1,24016 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.device import Device
+from authentik_client.models.duo_device import DuoDevice
+from authentik_client.models.duo_device_request import DuoDeviceRequest
+from authentik_client.models.email_device import EmailDevice
+from authentik_client.models.email_device_request import EmailDeviceRequest
+from authentik_client.models.google_endpoint_device import GoogleEndpointDevice
+from authentik_client.models.google_endpoint_device_request import GoogleEndpointDeviceRequest
+from authentik_client.models.paginated_duo_device_list import PaginatedDuoDeviceList
+from authentik_client.models.paginated_email_device_list import PaginatedEmailDeviceList
+from authentik_client.models.paginated_google_endpoint_device_list import PaginatedGoogleEndpointDeviceList
+from authentik_client.models.paginated_sms_device_list import PaginatedSMSDeviceList
+from authentik_client.models.paginated_static_device_list import PaginatedStaticDeviceList
+from authentik_client.models.paginated_totp_device_list import PaginatedTOTPDeviceList
+from authentik_client.models.paginated_web_authn_device_list import PaginatedWebAuthnDeviceList
+from authentik_client.models.patched_duo_device_request import PatchedDuoDeviceRequest
+from authentik_client.models.patched_email_device_request import PatchedEmailDeviceRequest
+from authentik_client.models.patched_google_endpoint_device_request import PatchedGoogleEndpointDeviceRequest
+from authentik_client.models.patched_sms_device_request import PatchedSMSDeviceRequest
+from authentik_client.models.patched_static_device_request import PatchedStaticDeviceRequest
+from authentik_client.models.patched_totp_device_request import PatchedTOTPDeviceRequest
+from authentik_client.models.patched_web_authn_device_request import PatchedWebAuthnDeviceRequest
+from authentik_client.models.sms_device import SMSDevice
+from authentik_client.models.sms_device_request import SMSDeviceRequest
+from authentik_client.models.static_device import StaticDevice
+from authentik_client.models.static_device_request import StaticDeviceRequest
+from authentik_client.models.totp_device import TOTPDevice
+from authentik_client.models.totp_device_request import TOTPDeviceRequest
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.web_authn_device import WebAuthnDevice
+from authentik_client.models.web_authn_device_request import WebAuthnDeviceRequest
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class AuthenticatorsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def authenticators_admin_all_list(
+ self,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[Device]:
+ """authenticators_admin_all_list
+
+ Get all devices for current user
+
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_all_list_serialize(
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[Device]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_all_list_with_http_info(
+ self,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[Device]]:
+ """authenticators_admin_all_list
+
+ Get all devices for current user
+
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_all_list_serialize(
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[Device]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_all_list_without_preload_content(
+ self,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_all_list
+
+ Get all devices for current user
+
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_all_list_serialize(
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[Device]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_all_list_serialize(
+ self,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_duo_create(
+ self,
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_admin_duo_create
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_create_serialize(
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_duo_create_with_http_info(
+ self,
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_admin_duo_create
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_create_serialize(
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_duo_create_without_preload_content(
+ self,
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_duo_create
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_create_serialize(
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_duo_create_serialize(
+ self,
+ duo_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if duo_device_request is not None:
+ _body_params = duo_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/duo/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_duo_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_duo_destroy
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_duo_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_duo_destroy
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_duo_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_duo_destroy
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_duo_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_duo_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDuoDeviceList:
+ """authenticators_admin_duo_list
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDuoDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_duo_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDuoDeviceList]:
+ """authenticators_admin_duo_list
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDuoDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_duo_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_duo_list
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDuoDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_duo_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/duo/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_duo_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ patched_duo_device_request: Optional[PatchedDuoDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_admin_duo_partial_update
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param patched_duo_device_request:
+ :type patched_duo_device_request: PatchedDuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_partial_update_serialize(
+ id=id,
+ patched_duo_device_request=patched_duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_duo_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ patched_duo_device_request: Optional[PatchedDuoDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_admin_duo_partial_update
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param patched_duo_device_request:
+ :type patched_duo_device_request: PatchedDuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_partial_update_serialize(
+ id=id,
+ patched_duo_device_request=patched_duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_duo_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ patched_duo_device_request: Optional[PatchedDuoDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_duo_partial_update
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param patched_duo_device_request:
+ :type patched_duo_device_request: PatchedDuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_partial_update_serialize(
+ id=id,
+ patched_duo_device_request=patched_duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_duo_partial_update_serialize(
+ self,
+ id,
+ patched_duo_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_duo_device_request is not None:
+ _body_params = patched_duo_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_duo_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_admin_duo_retrieve
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_duo_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_admin_duo_retrieve
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_duo_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_duo_retrieve
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_duo_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_duo_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_admin_duo_update
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_update_serialize(
+ id=id,
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_duo_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_admin_duo_update
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_update_serialize(
+ id=id,
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_duo_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_duo_update
+
+ Viewset for Duo authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_duo_update_serialize(
+ id=id,
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_duo_update_serialize(
+ self,
+ id,
+ duo_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if duo_device_request is not None:
+ _body_params = duo_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_email_create(
+ self,
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_admin_email_create
+
+ Viewset for email authenticator devices (for admins)
+
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_create_serialize(
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_email_create_with_http_info(
+ self,
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_admin_email_create
+
+ Viewset for email authenticator devices (for admins)
+
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_create_serialize(
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_email_create_without_preload_content(
+ self,
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_email_create
+
+ Viewset for email authenticator devices (for admins)
+
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_create_serialize(
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_email_create_serialize(
+ self,
+ email_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if email_device_request is not None:
+ _body_params = email_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/email/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_email_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_email_destroy
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_email_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_email_destroy
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_email_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_email_destroy
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_email_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_email_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEmailDeviceList:
+ """authenticators_admin_email_list
+
+ Viewset for email authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEmailDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_email_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEmailDeviceList]:
+ """authenticators_admin_email_list
+
+ Viewset for email authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEmailDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_email_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_email_list
+
+ Viewset for email authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEmailDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_email_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/email/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_email_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ patched_email_device_request: Optional[PatchedEmailDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_admin_email_partial_update
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param patched_email_device_request:
+ :type patched_email_device_request: PatchedEmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_partial_update_serialize(
+ id=id,
+ patched_email_device_request=patched_email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_email_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ patched_email_device_request: Optional[PatchedEmailDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_admin_email_partial_update
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param patched_email_device_request:
+ :type patched_email_device_request: PatchedEmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_partial_update_serialize(
+ id=id,
+ patched_email_device_request=patched_email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_email_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ patched_email_device_request: Optional[PatchedEmailDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_email_partial_update
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param patched_email_device_request:
+ :type patched_email_device_request: PatchedEmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_partial_update_serialize(
+ id=id,
+ patched_email_device_request=patched_email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_email_partial_update_serialize(
+ self,
+ id,
+ patched_email_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_email_device_request is not None:
+ _body_params = patched_email_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_email_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_admin_email_retrieve
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_email_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_admin_email_retrieve
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_email_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_email_retrieve
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_email_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_email_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_admin_email_update
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_update_serialize(
+ id=id,
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_email_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_admin_email_update
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_update_serialize(
+ id=id,
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_email_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_email_update
+
+ Viewset for email authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_email_update_serialize(
+ id=id,
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_email_update_serialize(
+ self,
+ id,
+ email_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if email_device_request is not None:
+ _body_params = email_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_endpoint_create(
+ self,
+ google_endpoint_device_request: GoogleEndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleEndpointDevice:
+ """authenticators_admin_endpoint_create
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param google_endpoint_device_request: (required)
+ :type google_endpoint_device_request: GoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_create_serialize(
+ google_endpoint_device_request=google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_endpoint_create_with_http_info(
+ self,
+ google_endpoint_device_request: GoogleEndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleEndpointDevice]:
+ """authenticators_admin_endpoint_create
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param google_endpoint_device_request: (required)
+ :type google_endpoint_device_request: GoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_create_serialize(
+ google_endpoint_device_request=google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_endpoint_create_without_preload_content(
+ self,
+ google_endpoint_device_request: GoogleEndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_endpoint_create
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param google_endpoint_device_request: (required)
+ :type google_endpoint_device_request: GoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_create_serialize(
+ google_endpoint_device_request=google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_endpoint_create_serialize(
+ self,
+ google_endpoint_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_endpoint_device_request is not None:
+ _body_params = google_endpoint_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/endpoint/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_endpoint_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_endpoint_destroy
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_endpoint_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_endpoint_destroy
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_endpoint_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_endpoint_destroy
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_endpoint_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/endpoint/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_endpoint_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleEndpointDeviceList:
+ """authenticators_admin_endpoint_list
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_endpoint_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleEndpointDeviceList]:
+ """authenticators_admin_endpoint_list
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_endpoint_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_endpoint_list
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_endpoint_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/endpoint/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_endpoint_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ patched_google_endpoint_device_request: Optional[PatchedGoogleEndpointDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleEndpointDevice:
+ """authenticators_admin_endpoint_partial_update
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param patched_google_endpoint_device_request:
+ :type patched_google_endpoint_device_request: PatchedGoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_partial_update_serialize(
+ uuid=uuid,
+ patched_google_endpoint_device_request=patched_google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_endpoint_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ patched_google_endpoint_device_request: Optional[PatchedGoogleEndpointDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleEndpointDevice]:
+ """authenticators_admin_endpoint_partial_update
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param patched_google_endpoint_device_request:
+ :type patched_google_endpoint_device_request: PatchedGoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_partial_update_serialize(
+ uuid=uuid,
+ patched_google_endpoint_device_request=patched_google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_endpoint_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ patched_google_endpoint_device_request: Optional[PatchedGoogleEndpointDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_endpoint_partial_update
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param patched_google_endpoint_device_request:
+ :type patched_google_endpoint_device_request: PatchedGoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_partial_update_serialize(
+ uuid=uuid,
+ patched_google_endpoint_device_request=patched_google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_endpoint_partial_update_serialize(
+ self,
+ uuid,
+ patched_google_endpoint_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_google_endpoint_device_request is not None:
+ _body_params = patched_google_endpoint_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/endpoint/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_endpoint_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleEndpointDevice:
+ """authenticators_admin_endpoint_retrieve
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_endpoint_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleEndpointDevice]:
+ """authenticators_admin_endpoint_retrieve
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_endpoint_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_endpoint_retrieve
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_endpoint_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/endpoint/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_endpoint_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ google_endpoint_device_request: GoogleEndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleEndpointDevice:
+ """authenticators_admin_endpoint_update
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param google_endpoint_device_request: (required)
+ :type google_endpoint_device_request: GoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_update_serialize(
+ uuid=uuid,
+ google_endpoint_device_request=google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_endpoint_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ google_endpoint_device_request: GoogleEndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleEndpointDevice]:
+ """authenticators_admin_endpoint_update
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param google_endpoint_device_request: (required)
+ :type google_endpoint_device_request: GoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_update_serialize(
+ uuid=uuid,
+ google_endpoint_device_request=google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_endpoint_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ google_endpoint_device_request: GoogleEndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_endpoint_update
+
+ Viewset for Endpoint authenticator devices (for admins)
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param google_endpoint_device_request: (required)
+ :type google_endpoint_device_request: GoogleEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_endpoint_update_serialize(
+ uuid=uuid,
+ google_endpoint_device_request=google_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_endpoint_update_serialize(
+ self,
+ uuid,
+ google_endpoint_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_endpoint_device_request is not None:
+ _body_params = google_endpoint_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/endpoint/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_sms_create(
+ self,
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_admin_sms_create
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_create_serialize(
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_sms_create_with_http_info(
+ self,
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_admin_sms_create
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_create_serialize(
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_sms_create_without_preload_content(
+ self,
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_sms_create
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_create_serialize(
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_sms_create_serialize(
+ self,
+ sms_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if sms_device_request is not None:
+ _body_params = sms_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/sms/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_sms_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_sms_destroy
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_sms_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_sms_destroy
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_sms_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_sms_destroy
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_sms_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_sms_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSMSDeviceList:
+ """authenticators_admin_sms_list
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSMSDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_sms_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSMSDeviceList]:
+ """authenticators_admin_sms_list
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSMSDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_sms_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_sms_list
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSMSDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_sms_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/sms/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_sms_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ patched_sms_device_request: Optional[PatchedSMSDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_admin_sms_partial_update
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param patched_sms_device_request:
+ :type patched_sms_device_request: PatchedSMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_partial_update_serialize(
+ id=id,
+ patched_sms_device_request=patched_sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_sms_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ patched_sms_device_request: Optional[PatchedSMSDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_admin_sms_partial_update
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param patched_sms_device_request:
+ :type patched_sms_device_request: PatchedSMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_partial_update_serialize(
+ id=id,
+ patched_sms_device_request=patched_sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_sms_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ patched_sms_device_request: Optional[PatchedSMSDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_sms_partial_update
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param patched_sms_device_request:
+ :type patched_sms_device_request: PatchedSMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_partial_update_serialize(
+ id=id,
+ patched_sms_device_request=patched_sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_sms_partial_update_serialize(
+ self,
+ id,
+ patched_sms_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_sms_device_request is not None:
+ _body_params = patched_sms_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_sms_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_admin_sms_retrieve
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_sms_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_admin_sms_retrieve
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_sms_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_sms_retrieve
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_sms_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_sms_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_admin_sms_update
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_update_serialize(
+ id=id,
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_sms_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_admin_sms_update
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_update_serialize(
+ id=id,
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_sms_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_sms_update
+
+ Viewset for sms authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_sms_update_serialize(
+ id=id,
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_sms_update_serialize(
+ self,
+ id,
+ sms_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if sms_device_request is not None:
+ _body_params = sms_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_static_create(
+ self,
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_admin_static_create
+
+ Viewset for static authenticator devices (for admins)
+
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_create_serialize(
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_static_create_with_http_info(
+ self,
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_admin_static_create
+
+ Viewset for static authenticator devices (for admins)
+
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_create_serialize(
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_static_create_without_preload_content(
+ self,
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_static_create
+
+ Viewset for static authenticator devices (for admins)
+
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_create_serialize(
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_static_create_serialize(
+ self,
+ static_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if static_device_request is not None:
+ _body_params = static_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/static/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_static_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_static_destroy
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_static_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_static_destroy
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_static_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_static_destroy
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_static_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_static_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedStaticDeviceList:
+ """authenticators_admin_static_list
+
+ Viewset for static authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedStaticDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_static_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedStaticDeviceList]:
+ """authenticators_admin_static_list
+
+ Viewset for static authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedStaticDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_static_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_static_list
+
+ Viewset for static authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedStaticDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_static_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/static/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_static_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ patched_static_device_request: Optional[PatchedStaticDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_admin_static_partial_update
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param patched_static_device_request:
+ :type patched_static_device_request: PatchedStaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_partial_update_serialize(
+ id=id,
+ patched_static_device_request=patched_static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_static_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ patched_static_device_request: Optional[PatchedStaticDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_admin_static_partial_update
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param patched_static_device_request:
+ :type patched_static_device_request: PatchedStaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_partial_update_serialize(
+ id=id,
+ patched_static_device_request=patched_static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_static_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ patched_static_device_request: Optional[PatchedStaticDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_static_partial_update
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param patched_static_device_request:
+ :type patched_static_device_request: PatchedStaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_partial_update_serialize(
+ id=id,
+ patched_static_device_request=patched_static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_static_partial_update_serialize(
+ self,
+ id,
+ patched_static_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_static_device_request is not None:
+ _body_params = patched_static_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_static_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_admin_static_retrieve
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_static_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_admin_static_retrieve
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_static_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_static_retrieve
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_static_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_static_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_admin_static_update
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_update_serialize(
+ id=id,
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_static_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_admin_static_update
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_update_serialize(
+ id=id,
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_static_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_static_update
+
+ Viewset for static authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_static_update_serialize(
+ id=id,
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_static_update_serialize(
+ self,
+ id,
+ static_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if static_device_request is not None:
+ _body_params = static_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_totp_create(
+ self,
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_admin_totp_create
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_create_serialize(
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_totp_create_with_http_info(
+ self,
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_admin_totp_create
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_create_serialize(
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_totp_create_without_preload_content(
+ self,
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_totp_create
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_create_serialize(
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_totp_create_serialize(
+ self,
+ totp_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if totp_device_request is not None:
+ _body_params = totp_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/totp/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_totp_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_totp_destroy
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_totp_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_totp_destroy
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_totp_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_totp_destroy
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_totp_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_totp_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedTOTPDeviceList:
+ """authenticators_admin_totp_list
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTOTPDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_totp_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedTOTPDeviceList]:
+ """authenticators_admin_totp_list
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTOTPDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_totp_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_totp_list
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTOTPDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_totp_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/totp/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_totp_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ patched_totp_device_request: Optional[PatchedTOTPDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_admin_totp_partial_update
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param patched_totp_device_request:
+ :type patched_totp_device_request: PatchedTOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_partial_update_serialize(
+ id=id,
+ patched_totp_device_request=patched_totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_totp_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ patched_totp_device_request: Optional[PatchedTOTPDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_admin_totp_partial_update
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param patched_totp_device_request:
+ :type patched_totp_device_request: PatchedTOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_partial_update_serialize(
+ id=id,
+ patched_totp_device_request=patched_totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_totp_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ patched_totp_device_request: Optional[PatchedTOTPDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_totp_partial_update
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param patched_totp_device_request:
+ :type patched_totp_device_request: PatchedTOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_partial_update_serialize(
+ id=id,
+ patched_totp_device_request=patched_totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_totp_partial_update_serialize(
+ self,
+ id,
+ patched_totp_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_totp_device_request is not None:
+ _body_params = patched_totp_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_totp_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_admin_totp_retrieve
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_totp_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_admin_totp_retrieve
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_totp_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_totp_retrieve
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_totp_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_totp_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_admin_totp_update
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_update_serialize(
+ id=id,
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_totp_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_admin_totp_update
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_update_serialize(
+ id=id,
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_totp_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_totp_update
+
+ Viewset for totp authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_totp_update_serialize(
+ id=id,
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_totp_update_serialize(
+ self,
+ id,
+ totp_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if totp_device_request is not None:
+ _body_params = totp_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_webauthn_create(
+ self,
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_admin_webauthn_create
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_create_serialize(
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_webauthn_create_with_http_info(
+ self,
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_admin_webauthn_create
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_create_serialize(
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_webauthn_create_without_preload_content(
+ self,
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_webauthn_create
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_create_serialize(
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_webauthn_create_serialize(
+ self,
+ web_authn_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if web_authn_device_request is not None:
+ _body_params = web_authn_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/authenticators/admin/webauthn/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_webauthn_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_admin_webauthn_destroy
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_webauthn_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_admin_webauthn_destroy
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_webauthn_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_webauthn_destroy
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_webauthn_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/admin/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_webauthn_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedWebAuthnDeviceList:
+ """authenticators_admin_webauthn_list
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWebAuthnDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_webauthn_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedWebAuthnDeviceList]:
+ """authenticators_admin_webauthn_list
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWebAuthnDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_webauthn_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_webauthn_list
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWebAuthnDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_webauthn_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/webauthn/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_webauthn_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ patched_web_authn_device_request: Optional[PatchedWebAuthnDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_admin_webauthn_partial_update
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param patched_web_authn_device_request:
+ :type patched_web_authn_device_request: PatchedWebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_partial_update_serialize(
+ id=id,
+ patched_web_authn_device_request=patched_web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_webauthn_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ patched_web_authn_device_request: Optional[PatchedWebAuthnDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_admin_webauthn_partial_update
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param patched_web_authn_device_request:
+ :type patched_web_authn_device_request: PatchedWebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_partial_update_serialize(
+ id=id,
+ patched_web_authn_device_request=patched_web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_webauthn_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ patched_web_authn_device_request: Optional[PatchedWebAuthnDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_webauthn_partial_update
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param patched_web_authn_device_request:
+ :type patched_web_authn_device_request: PatchedWebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_partial_update_serialize(
+ id=id,
+ patched_web_authn_device_request=patched_web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_webauthn_partial_update_serialize(
+ self,
+ id,
+ patched_web_authn_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_web_authn_device_request is not None:
+ _body_params = patched_web_authn_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/admin/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_webauthn_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_admin_webauthn_retrieve
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_webauthn_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_admin_webauthn_retrieve
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_webauthn_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_webauthn_retrieve
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_webauthn_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/admin/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_admin_webauthn_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_admin_webauthn_update
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_update_serialize(
+ id=id,
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_admin_webauthn_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_admin_webauthn_update
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_update_serialize(
+ id=id,
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_admin_webauthn_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_admin_webauthn_update
+
+ Viewset for WebAuthn authenticator devices (for admins)
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_admin_webauthn_update_serialize(
+ id=id,
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_admin_webauthn_update_serialize(
+ self,
+ id,
+ web_authn_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if web_authn_device_request is not None:
+ _body_params = web_authn_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/admin/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_all_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[Device]:
+ """authenticators_all_list
+
+ Get all devices for current user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_all_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[Device]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_all_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[Device]]:
+ """authenticators_all_list
+
+ Get all devices for current user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_all_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[Device]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_all_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_all_list
+
+ Get all devices for current user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_all_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[Device]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_all_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_duo_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_duo_destroy
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_duo_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_duo_destroy
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_duo_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_duo_destroy
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_duo_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_duo_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDuoDeviceList:
+ """authenticators_duo_list
+
+ Viewset for Duo authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDuoDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_duo_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDuoDeviceList]:
+ """authenticators_duo_list
+
+ Viewset for Duo authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDuoDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_duo_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_duo_list
+
+ Viewset for Duo authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDuoDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_duo_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/duo/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_duo_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ patched_duo_device_request: Optional[PatchedDuoDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_duo_partial_update
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param patched_duo_device_request:
+ :type patched_duo_device_request: PatchedDuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_partial_update_serialize(
+ id=id,
+ patched_duo_device_request=patched_duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_duo_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ patched_duo_device_request: Optional[PatchedDuoDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_duo_partial_update
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param patched_duo_device_request:
+ :type patched_duo_device_request: PatchedDuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_partial_update_serialize(
+ id=id,
+ patched_duo_device_request=patched_duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_duo_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ patched_duo_device_request: Optional[PatchedDuoDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_duo_partial_update
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param patched_duo_device_request:
+ :type patched_duo_device_request: PatchedDuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_partial_update_serialize(
+ id=id,
+ patched_duo_device_request=patched_duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_duo_partial_update_serialize(
+ self,
+ id,
+ patched_duo_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_duo_device_request is not None:
+ _body_params = patched_duo_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_duo_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_duo_retrieve
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_duo_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_duo_retrieve
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_duo_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_duo_retrieve
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_duo_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_duo_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DuoDevice:
+ """authenticators_duo_update
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_update_serialize(
+ id=id,
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_duo_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DuoDevice]:
+ """authenticators_duo_update
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_update_serialize(
+ id=id,
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_duo_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ duo_device_request: DuoDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_duo_update
+
+ Viewset for Duo authenticator devices
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param duo_device_request: (required)
+ :type duo_device_request: DuoDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_update_serialize(
+ id=id,
+ duo_device_request=duo_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DuoDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_duo_update_serialize(
+ self,
+ id,
+ duo_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if duo_device_request is not None:
+ _body_params = duo_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/duo/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_duo_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_duo_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_duo_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_duo_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_duo_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Duo Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_duo_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Duo Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_duo_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_duo_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/duo/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_email_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_email_destroy
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_email_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_email_destroy
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_email_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_email_destroy
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_email_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_email_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEmailDeviceList:
+ """authenticators_email_list
+
+ Viewset for email authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEmailDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_email_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEmailDeviceList]:
+ """authenticators_email_list
+
+ Viewset for email authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEmailDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_email_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_email_list
+
+ Viewset for email authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEmailDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_email_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/email/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_email_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ patched_email_device_request: Optional[PatchedEmailDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_email_partial_update
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param patched_email_device_request:
+ :type patched_email_device_request: PatchedEmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_partial_update_serialize(
+ id=id,
+ patched_email_device_request=patched_email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_email_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ patched_email_device_request: Optional[PatchedEmailDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_email_partial_update
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param patched_email_device_request:
+ :type patched_email_device_request: PatchedEmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_partial_update_serialize(
+ id=id,
+ patched_email_device_request=patched_email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_email_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ patched_email_device_request: Optional[PatchedEmailDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_email_partial_update
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param patched_email_device_request:
+ :type patched_email_device_request: PatchedEmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_partial_update_serialize(
+ id=id,
+ patched_email_device_request=patched_email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_email_partial_update_serialize(
+ self,
+ id,
+ patched_email_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_email_device_request is not None:
+ _body_params = patched_email_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_email_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_email_retrieve
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_email_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_email_retrieve
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_email_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_email_retrieve
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_email_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_email_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EmailDevice:
+ """authenticators_email_update
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_update_serialize(
+ id=id,
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_email_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EmailDevice]:
+ """authenticators_email_update
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_update_serialize(
+ id=id,
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_email_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ email_device_request: EmailDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_email_update
+
+ Viewset for email authenticator devices
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param email_device_request: (required)
+ :type email_device_request: EmailDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_update_serialize(
+ id=id,
+ email_device_request=email_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EmailDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_email_update_serialize(
+ self,
+ id,
+ email_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if email_device_request is not None:
+ _body_params = email_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/email/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_email_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_email_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_email_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_email_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_email_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Email Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_email_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Email Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_email_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_email_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/email/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_endpoint_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleEndpointDeviceList:
+ """authenticators_endpoint_list
+
+ Viewset for Endpoint authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_endpoint_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleEndpointDeviceList]:
+ """authenticators_endpoint_list
+
+ Viewset for Endpoint authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_endpoint_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_endpoint_list
+
+ Viewset for Endpoint authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_endpoint_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/endpoint/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_endpoint_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleEndpointDevice:
+ """authenticators_endpoint_retrieve
+
+ Viewset for Endpoint authenticator devices
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_endpoint_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleEndpointDevice]:
+ """authenticators_endpoint_retrieve
+
+ Viewset for Endpoint authenticator devices
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_endpoint_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_endpoint_retrieve
+
+ Viewset for Endpoint authenticator devices
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleEndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_endpoint_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/endpoint/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_endpoint_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_endpoint_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_endpoint_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_endpoint_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_endpoint_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Endpoint Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_endpoint_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Endpoint Device. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_endpoint_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_endpoint_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/endpoint/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_sms_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_sms_destroy
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_sms_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_sms_destroy
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_sms_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_sms_destroy
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_sms_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_sms_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSMSDeviceList:
+ """authenticators_sms_list
+
+ Viewset for sms authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSMSDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_sms_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSMSDeviceList]:
+ """authenticators_sms_list
+
+ Viewset for sms authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSMSDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_sms_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_sms_list
+
+ Viewset for sms authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSMSDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_sms_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/sms/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_sms_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ patched_sms_device_request: Optional[PatchedSMSDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_sms_partial_update
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param patched_sms_device_request:
+ :type patched_sms_device_request: PatchedSMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_partial_update_serialize(
+ id=id,
+ patched_sms_device_request=patched_sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_sms_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ patched_sms_device_request: Optional[PatchedSMSDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_sms_partial_update
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param patched_sms_device_request:
+ :type patched_sms_device_request: PatchedSMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_partial_update_serialize(
+ id=id,
+ patched_sms_device_request=patched_sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_sms_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ patched_sms_device_request: Optional[PatchedSMSDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_sms_partial_update
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param patched_sms_device_request:
+ :type patched_sms_device_request: PatchedSMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_partial_update_serialize(
+ id=id,
+ patched_sms_device_request=patched_sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_sms_partial_update_serialize(
+ self,
+ id,
+ patched_sms_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_sms_device_request is not None:
+ _body_params = patched_sms_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_sms_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_sms_retrieve
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_sms_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_sms_retrieve
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_sms_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_sms_retrieve
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_sms_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_sms_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SMSDevice:
+ """authenticators_sms_update
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_update_serialize(
+ id=id,
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_sms_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SMSDevice]:
+ """authenticators_sms_update
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_update_serialize(
+ id=id,
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_sms_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ sms_device_request: SMSDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_sms_update
+
+ Viewset for sms authenticator devices
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param sms_device_request: (required)
+ :type sms_device_request: SMSDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_update_serialize(
+ id=id,
+ sms_device_request=sms_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SMSDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_sms_update_serialize(
+ self,
+ id,
+ sms_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if sms_device_request is not None:
+ _body_params = sms_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/sms/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_sms_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_sms_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_sms_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_sms_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_sms_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SMS Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_sms_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SMS Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_sms_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_sms_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/sms/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_static_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_static_destroy
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_static_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_static_destroy
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_static_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_static_destroy
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_static_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_static_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedStaticDeviceList:
+ """authenticators_static_list
+
+ Viewset for static authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedStaticDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_static_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedStaticDeviceList]:
+ """authenticators_static_list
+
+ Viewset for static authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedStaticDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_static_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_static_list
+
+ Viewset for static authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedStaticDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_static_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/static/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_static_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ patched_static_device_request: Optional[PatchedStaticDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_static_partial_update
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param patched_static_device_request:
+ :type patched_static_device_request: PatchedStaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_partial_update_serialize(
+ id=id,
+ patched_static_device_request=patched_static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_static_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ patched_static_device_request: Optional[PatchedStaticDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_static_partial_update
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param patched_static_device_request:
+ :type patched_static_device_request: PatchedStaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_partial_update_serialize(
+ id=id,
+ patched_static_device_request=patched_static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_static_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ patched_static_device_request: Optional[PatchedStaticDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_static_partial_update
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param patched_static_device_request:
+ :type patched_static_device_request: PatchedStaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_partial_update_serialize(
+ id=id,
+ patched_static_device_request=patched_static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_static_partial_update_serialize(
+ self,
+ id,
+ patched_static_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_static_device_request is not None:
+ _body_params = patched_static_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_static_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_static_retrieve
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_static_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_static_retrieve
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_static_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_static_retrieve
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_static_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_static_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> StaticDevice:
+ """authenticators_static_update
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_update_serialize(
+ id=id,
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_static_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[StaticDevice]:
+ """authenticators_static_update
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_update_serialize(
+ id=id,
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_static_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ static_device_request: StaticDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_static_update
+
+ Viewset for static authenticator devices
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param static_device_request: (required)
+ :type static_device_request: StaticDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_update_serialize(
+ id=id,
+ static_device_request=static_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "StaticDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_static_update_serialize(
+ self,
+ id,
+ static_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if static_device_request is not None:
+ _body_params = static_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/static/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_static_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_static_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_static_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_static_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_static_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Static Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_static_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Static Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_static_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_static_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/static/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_totp_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_totp_destroy
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_totp_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_totp_destroy
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_totp_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_totp_destroy
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_totp_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_totp_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedTOTPDeviceList:
+ """authenticators_totp_list
+
+ Viewset for totp authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTOTPDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_totp_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedTOTPDeviceList]:
+ """authenticators_totp_list
+
+ Viewset for totp authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTOTPDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_totp_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_totp_list
+
+ Viewset for totp authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTOTPDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_totp_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/totp/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_totp_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ patched_totp_device_request: Optional[PatchedTOTPDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_totp_partial_update
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param patched_totp_device_request:
+ :type patched_totp_device_request: PatchedTOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_partial_update_serialize(
+ id=id,
+ patched_totp_device_request=patched_totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_totp_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ patched_totp_device_request: Optional[PatchedTOTPDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_totp_partial_update
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param patched_totp_device_request:
+ :type patched_totp_device_request: PatchedTOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_partial_update_serialize(
+ id=id,
+ patched_totp_device_request=patched_totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_totp_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ patched_totp_device_request: Optional[PatchedTOTPDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_totp_partial_update
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param patched_totp_device_request:
+ :type patched_totp_device_request: PatchedTOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_partial_update_serialize(
+ id=id,
+ patched_totp_device_request=patched_totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_totp_partial_update_serialize(
+ self,
+ id,
+ patched_totp_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_totp_device_request is not None:
+ _body_params = patched_totp_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_totp_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_totp_retrieve
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_totp_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_totp_retrieve
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_totp_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_totp_retrieve
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_totp_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_totp_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TOTPDevice:
+ """authenticators_totp_update
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_update_serialize(
+ id=id,
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_totp_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TOTPDevice]:
+ """authenticators_totp_update
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_update_serialize(
+ id=id,
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_totp_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ totp_device_request: TOTPDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_totp_update
+
+ Viewset for totp authenticator devices
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param totp_device_request: (required)
+ :type totp_device_request: TOTPDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_update_serialize(
+ id=id,
+ totp_device_request=totp_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TOTPDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_totp_update_serialize(
+ self,
+ id,
+ totp_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if totp_device_request is not None:
+ _body_params = totp_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/totp/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_totp_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_totp_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_totp_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_totp_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_totp_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this TOTP Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_totp_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this TOTP Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_totp_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_totp_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/totp/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_webauthn_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """authenticators_webauthn_destroy
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_webauthn_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """authenticators_webauthn_destroy
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_webauthn_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_webauthn_destroy
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_webauthn_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/authenticators/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_webauthn_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedWebAuthnDeviceList:
+ """authenticators_webauthn_list
+
+ Viewset for WebAuthn authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWebAuthnDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_webauthn_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedWebAuthnDeviceList]:
+ """authenticators_webauthn_list
+
+ Viewset for WebAuthn authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWebAuthnDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_webauthn_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_webauthn_list
+
+ Viewset for WebAuthn authenticator devices
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWebAuthnDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_webauthn_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/webauthn/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_webauthn_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ patched_web_authn_device_request: Optional[PatchedWebAuthnDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_webauthn_partial_update
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param patched_web_authn_device_request:
+ :type patched_web_authn_device_request: PatchedWebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_partial_update_serialize(
+ id=id,
+ patched_web_authn_device_request=patched_web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_webauthn_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ patched_web_authn_device_request: Optional[PatchedWebAuthnDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_webauthn_partial_update
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param patched_web_authn_device_request:
+ :type patched_web_authn_device_request: PatchedWebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_partial_update_serialize(
+ id=id,
+ patched_web_authn_device_request=patched_web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_webauthn_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ patched_web_authn_device_request: Optional[PatchedWebAuthnDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_webauthn_partial_update
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param patched_web_authn_device_request:
+ :type patched_web_authn_device_request: PatchedWebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_partial_update_serialize(
+ id=id,
+ patched_web_authn_device_request=patched_web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_webauthn_partial_update_serialize(
+ self,
+ id,
+ patched_web_authn_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_web_authn_device_request is not None:
+ _body_params = patched_web_authn_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/authenticators/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_webauthn_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_webauthn_retrieve
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_webauthn_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_webauthn_retrieve
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_webauthn_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_webauthn_retrieve
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_webauthn_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_webauthn_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WebAuthnDevice:
+ """authenticators_webauthn_update
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_update_serialize(
+ id=id,
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_webauthn_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WebAuthnDevice]:
+ """authenticators_webauthn_update
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_update_serialize(
+ id=id,
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_webauthn_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ web_authn_device_request: WebAuthnDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_webauthn_update
+
+ Viewset for WebAuthn authenticator devices
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param web_authn_device_request: (required)
+ :type web_authn_device_request: WebAuthnDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_update_serialize(
+ id=id,
+ web_authn_device_request=web_authn_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WebAuthnDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_webauthn_update_serialize(
+ self,
+ id,
+ web_authn_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if web_authn_device_request is not None:
+ _body_params = web_authn_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/authenticators/webauthn/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def authenticators_webauthn_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """authenticators_webauthn_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def authenticators_webauthn_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """authenticators_webauthn_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def authenticators_webauthn_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WebAuthn Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """authenticators_webauthn_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this WebAuthn Device. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._authenticators_webauthn_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _authenticators_webauthn_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/authenticators/webauthn/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/core_api.py b/authentik_client/api/core_api.py
new file mode 100644
index 000000000..a765852f8
--- /dev/null
+++ b/authentik_client/api/core_api.py
@@ -0,0 +1,21558 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from datetime import datetime
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.application import Application
+from authentik_client.models.application_entitlement import ApplicationEntitlement
+from authentik_client.models.application_entitlement_request import ApplicationEntitlementRequest
+from authentik_client.models.application_request import ApplicationRequest
+from authentik_client.models.authenticated_session import AuthenticatedSession
+from authentik_client.models.brand import Brand
+from authentik_client.models.brand_request import BrandRequest
+from authentik_client.models.bulk_delete_session_response import BulkDeleteSessionResponse
+from authentik_client.models.current_brand import CurrentBrand
+from authentik_client.models.data_export import DataExport
+from authentik_client.models.group import Group
+from authentik_client.models.group_request import GroupRequest
+from authentik_client.models.impersonation_request import ImpersonationRequest
+from authentik_client.models.intent_enum import IntentEnum
+from authentik_client.models.link import Link
+from authentik_client.models.paginated_application_entitlement_list import PaginatedApplicationEntitlementList
+from authentik_client.models.paginated_application_list import PaginatedApplicationList
+from authentik_client.models.paginated_authenticated_session_list import PaginatedAuthenticatedSessionList
+from authentik_client.models.paginated_brand_list import PaginatedBrandList
+from authentik_client.models.paginated_group_list import PaginatedGroupList
+from authentik_client.models.paginated_token_list import PaginatedTokenList
+from authentik_client.models.paginated_user_consent_list import PaginatedUserConsentList
+from authentik_client.models.paginated_user_list import PaginatedUserList
+from authentik_client.models.patched_application_entitlement_request import PatchedApplicationEntitlementRequest
+from authentik_client.models.patched_application_request import PatchedApplicationRequest
+from authentik_client.models.patched_brand_request import PatchedBrandRequest
+from authentik_client.models.patched_group_request import PatchedGroupRequest
+from authentik_client.models.patched_token_request import PatchedTokenRequest
+from authentik_client.models.patched_user_request import PatchedUserRequest
+from authentik_client.models.policy_test_result import PolicyTestResult
+from authentik_client.models.session_user import SessionUser
+from authentik_client.models.token import Token
+from authentik_client.models.token_request import TokenRequest
+from authentik_client.models.token_set_key_request import TokenSetKeyRequest
+from authentik_client.models.token_view import TokenView
+from authentik_client.models.transaction_application_request import TransactionApplicationRequest
+from authentik_client.models.transaction_application_response import TransactionApplicationResponse
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.user import User
+from authentik_client.models.user_account_lockdown_request import UserAccountLockdownRequest
+from authentik_client.models.user_account_request import UserAccountRequest
+from authentik_client.models.user_consent import UserConsent
+from authentik_client.models.user_password_hash_set_request import UserPasswordHashSetRequest
+from authentik_client.models.user_password_set_request import UserPasswordSetRequest
+from authentik_client.models.user_path import UserPath
+from authentik_client.models.user_recovery_email_request import UserRecoveryEmailRequest
+from authentik_client.models.user_recovery_link_request import UserRecoveryLinkRequest
+from authentik_client.models.user_request import UserRequest
+from authentik_client.models.user_service_account_request import UserServiceAccountRequest
+from authentik_client.models.user_service_account_response import UserServiceAccountResponse
+from authentik_client.models.user_type_enum import UserTypeEnum
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class CoreApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def core_application_entitlements_create(
+ self,
+ application_entitlement_request: ApplicationEntitlementRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApplicationEntitlement:
+ """core_application_entitlements_create
+
+ ApplicationEntitlement Viewset
+
+ :param application_entitlement_request: (required)
+ :type application_entitlement_request: ApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_create_serialize(
+ application_entitlement_request=application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_create_with_http_info(
+ self,
+ application_entitlement_request: ApplicationEntitlementRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ApplicationEntitlement]:
+ """core_application_entitlements_create
+
+ ApplicationEntitlement Viewset
+
+ :param application_entitlement_request: (required)
+ :type application_entitlement_request: ApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_create_serialize(
+ application_entitlement_request=application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_create_without_preload_content(
+ self,
+ application_entitlement_request: ApplicationEntitlementRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_create
+
+ ApplicationEntitlement Viewset
+
+ :param application_entitlement_request: (required)
+ :type application_entitlement_request: ApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_create_serialize(
+ application_entitlement_request=application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_create_serialize(
+ self,
+ application_entitlement_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if application_entitlement_request is not None:
+ _body_params = application_entitlement_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/application_entitlements/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_application_entitlements_destroy(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_application_entitlements_destroy
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_destroy_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_application_entitlements_destroy
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_destroy_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_destroy
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_destroy_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/application_entitlements/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_application_entitlements_list(
+ self,
+ app: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedApplicationEntitlementList:
+ """core_application_entitlements_list
+
+ ApplicationEntitlement Viewset
+
+ :param app:
+ :type app: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_list_serialize(
+ app=app,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedApplicationEntitlementList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_list_with_http_info(
+ self,
+ app: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedApplicationEntitlementList]:
+ """core_application_entitlements_list
+
+ ApplicationEntitlement Viewset
+
+ :param app:
+ :type app: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_list_serialize(
+ app=app,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedApplicationEntitlementList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_list_without_preload_content(
+ self,
+ app: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_list
+
+ ApplicationEntitlement Viewset
+
+ :param app:
+ :type app: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_list_serialize(
+ app=app,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedApplicationEntitlementList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_list_serialize(
+ self,
+ app,
+ name,
+ ordering,
+ page,
+ page_size,
+ pbm_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if app is not None:
+
+ _query_params.append(('app', app))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if pbm_uuid is not None:
+
+ _query_params.append(('pbm_uuid', pbm_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/application_entitlements/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_application_entitlements_partial_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ patched_application_entitlement_request: Optional[PatchedApplicationEntitlementRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApplicationEntitlement:
+ """core_application_entitlements_partial_update
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param patched_application_entitlement_request:
+ :type patched_application_entitlement_request: PatchedApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_application_entitlement_request=patched_application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_partial_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ patched_application_entitlement_request: Optional[PatchedApplicationEntitlementRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ApplicationEntitlement]:
+ """core_application_entitlements_partial_update
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param patched_application_entitlement_request:
+ :type patched_application_entitlement_request: PatchedApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_application_entitlement_request=patched_application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_partial_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ patched_application_entitlement_request: Optional[PatchedApplicationEntitlementRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_partial_update
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param patched_application_entitlement_request:
+ :type patched_application_entitlement_request: PatchedApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_application_entitlement_request=patched_application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_partial_update_serialize(
+ self,
+ pbm_uuid,
+ patched_application_entitlement_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_application_entitlement_request is not None:
+ _body_params = patched_application_entitlement_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/core/application_entitlements/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_application_entitlements_retrieve(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApplicationEntitlement:
+ """core_application_entitlements_retrieve
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_retrieve_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ApplicationEntitlement]:
+ """core_application_entitlements_retrieve
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_retrieve_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_retrieve
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_retrieve_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/application_entitlements/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_application_entitlements_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ application_entitlement_request: ApplicationEntitlementRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApplicationEntitlement:
+ """core_application_entitlements_update
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param application_entitlement_request: (required)
+ :type application_entitlement_request: ApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_update_serialize(
+ pbm_uuid=pbm_uuid,
+ application_entitlement_request=application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ application_entitlement_request: ApplicationEntitlementRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ApplicationEntitlement]:
+ """core_application_entitlements_update
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param application_entitlement_request: (required)
+ :type application_entitlement_request: ApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_update_serialize(
+ pbm_uuid=pbm_uuid,
+ application_entitlement_request=application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ application_entitlement_request: ApplicationEntitlementRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_update
+
+ ApplicationEntitlement Viewset
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param application_entitlement_request: (required)
+ :type application_entitlement_request: ApplicationEntitlementRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_update_serialize(
+ pbm_uuid=pbm_uuid,
+ application_entitlement_request=application_entitlement_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ApplicationEntitlement",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_update_serialize(
+ self,
+ pbm_uuid,
+ application_entitlement_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if application_entitlement_request is not None:
+ _body_params = application_entitlement_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/application_entitlements/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_application_entitlements_used_by_list(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_application_entitlements_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_application_entitlements_used_by_list_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_application_entitlements_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_application_entitlements_used_by_list_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Application Entitlement.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_application_entitlements_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Application Entitlement. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_application_entitlements_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_application_entitlements_used_by_list_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/application_entitlements/{pbm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_check_access_retrieve(
+ self,
+ slug: StrictStr,
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PolicyTestResult:
+ """core_applications_check_access_retrieve
+
+ Check access to a single application by slug
+
+ :param slug: (required)
+ :type slug: str
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_check_access_retrieve_serialize(
+ slug=slug,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyTestResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_check_access_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PolicyTestResult]:
+ """core_applications_check_access_retrieve
+
+ Check access to a single application by slug
+
+ :param slug: (required)
+ :type slug: str
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_check_access_retrieve_serialize(
+ slug=slug,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyTestResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_check_access_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_check_access_retrieve
+
+ Check access to a single application by slug
+
+ :param slug: (required)
+ :type slug: str
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_check_access_retrieve_serialize(
+ slug=slug,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyTestResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_check_access_retrieve_serialize(
+ self,
+ slug,
+ for_user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ if for_user is not None:
+
+ _query_params.append(('for_user', for_user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/applications/{slug}/check_access/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_create(
+ self,
+ application_request: ApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Application:
+ """core_applications_create
+
+ Application Viewset
+
+ :param application_request: (required)
+ :type application_request: ApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_create_serialize(
+ application_request=application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_create_with_http_info(
+ self,
+ application_request: ApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Application]:
+ """core_applications_create
+
+ Application Viewset
+
+ :param application_request: (required)
+ :type application_request: ApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_create_serialize(
+ application_request=application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_create_without_preload_content(
+ self,
+ application_request: ApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_create
+
+ Application Viewset
+
+ :param application_request: (required)
+ :type application_request: ApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_create_serialize(
+ application_request=application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_create_serialize(
+ self,
+ application_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if application_request is not None:
+ _body_params = application_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/applications/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_destroy(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_applications_destroy
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_destroy_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_applications_destroy
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_destroy_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_destroy
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_destroy_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/applications/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_list(
+ self,
+ for_user: Optional[StrictInt] = None,
+ group: Optional[StrictStr] = None,
+ meta_description: Optional[StrictStr] = None,
+ meta_launch_url: Optional[StrictStr] = None,
+ meta_publisher: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ only_with_launch_url: Optional[StrictBool] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ superuser_full_list: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedApplicationList:
+ """core_applications_list
+
+ Custom list method that checks Policy based access instead of guardian
+
+ :param for_user:
+ :type for_user: int
+ :param group:
+ :type group: str
+ :param meta_description:
+ :type meta_description: str
+ :param meta_launch_url:
+ :type meta_launch_url: str
+ :param meta_publisher:
+ :type meta_publisher: str
+ :param name:
+ :type name: str
+ :param only_with_launch_url:
+ :type only_with_launch_url: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param superuser_full_list:
+ :type superuser_full_list: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_list_serialize(
+ for_user=for_user,
+ group=group,
+ meta_description=meta_description,
+ meta_launch_url=meta_launch_url,
+ meta_publisher=meta_publisher,
+ name=name,
+ only_with_launch_url=only_with_launch_url,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ slug=slug,
+ superuser_full_list=superuser_full_list,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedApplicationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_list_with_http_info(
+ self,
+ for_user: Optional[StrictInt] = None,
+ group: Optional[StrictStr] = None,
+ meta_description: Optional[StrictStr] = None,
+ meta_launch_url: Optional[StrictStr] = None,
+ meta_publisher: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ only_with_launch_url: Optional[StrictBool] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ superuser_full_list: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedApplicationList]:
+ """core_applications_list
+
+ Custom list method that checks Policy based access instead of guardian
+
+ :param for_user:
+ :type for_user: int
+ :param group:
+ :type group: str
+ :param meta_description:
+ :type meta_description: str
+ :param meta_launch_url:
+ :type meta_launch_url: str
+ :param meta_publisher:
+ :type meta_publisher: str
+ :param name:
+ :type name: str
+ :param only_with_launch_url:
+ :type only_with_launch_url: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param superuser_full_list:
+ :type superuser_full_list: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_list_serialize(
+ for_user=for_user,
+ group=group,
+ meta_description=meta_description,
+ meta_launch_url=meta_launch_url,
+ meta_publisher=meta_publisher,
+ name=name,
+ only_with_launch_url=only_with_launch_url,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ slug=slug,
+ superuser_full_list=superuser_full_list,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedApplicationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_list_without_preload_content(
+ self,
+ for_user: Optional[StrictInt] = None,
+ group: Optional[StrictStr] = None,
+ meta_description: Optional[StrictStr] = None,
+ meta_launch_url: Optional[StrictStr] = None,
+ meta_publisher: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ only_with_launch_url: Optional[StrictBool] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ superuser_full_list: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_list
+
+ Custom list method that checks Policy based access instead of guardian
+
+ :param for_user:
+ :type for_user: int
+ :param group:
+ :type group: str
+ :param meta_description:
+ :type meta_description: str
+ :param meta_launch_url:
+ :type meta_launch_url: str
+ :param meta_publisher:
+ :type meta_publisher: str
+ :param name:
+ :type name: str
+ :param only_with_launch_url:
+ :type only_with_launch_url: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param superuser_full_list:
+ :type superuser_full_list: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_list_serialize(
+ for_user=for_user,
+ group=group,
+ meta_description=meta_description,
+ meta_launch_url=meta_launch_url,
+ meta_publisher=meta_publisher,
+ name=name,
+ only_with_launch_url=only_with_launch_url,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ slug=slug,
+ superuser_full_list=superuser_full_list,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedApplicationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_list_serialize(
+ self,
+ for_user,
+ group,
+ meta_description,
+ meta_launch_url,
+ meta_publisher,
+ name,
+ only_with_launch_url,
+ ordering,
+ page,
+ page_size,
+ search,
+ slug,
+ superuser_full_list,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if for_user is not None:
+
+ _query_params.append(('for_user', for_user))
+
+ if group is not None:
+
+ _query_params.append(('group', group))
+
+ if meta_description is not None:
+
+ _query_params.append(('meta_description', meta_description))
+
+ if meta_launch_url is not None:
+
+ _query_params.append(('meta_launch_url', meta_launch_url))
+
+ if meta_publisher is not None:
+
+ _query_params.append(('meta_publisher', meta_publisher))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if only_with_launch_url is not None:
+
+ _query_params.append(('only_with_launch_url', only_with_launch_url))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if slug is not None:
+
+ _query_params.append(('slug', slug))
+
+ if superuser_full_list is not None:
+
+ _query_params.append(('superuser_full_list', superuser_full_list))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/applications/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_partial_update(
+ self,
+ slug: StrictStr,
+ patched_application_request: Optional[PatchedApplicationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Application:
+ """core_applications_partial_update
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param patched_application_request:
+ :type patched_application_request: PatchedApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_partial_update_serialize(
+ slug=slug,
+ patched_application_request=patched_application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_partial_update_with_http_info(
+ self,
+ slug: StrictStr,
+ patched_application_request: Optional[PatchedApplicationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Application]:
+ """core_applications_partial_update
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param patched_application_request:
+ :type patched_application_request: PatchedApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_partial_update_serialize(
+ slug=slug,
+ patched_application_request=patched_application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_partial_update_without_preload_content(
+ self,
+ slug: StrictStr,
+ patched_application_request: Optional[PatchedApplicationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_partial_update
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param patched_application_request:
+ :type patched_application_request: PatchedApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_partial_update_serialize(
+ slug=slug,
+ patched_application_request=patched_application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_partial_update_serialize(
+ self,
+ slug,
+ patched_application_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_application_request is not None:
+ _body_params = patched_application_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/core/applications/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_retrieve(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Application:
+ """core_applications_retrieve
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Application]:
+ """core_applications_retrieve
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_retrieve
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_retrieve_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/applications/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_update(
+ self,
+ slug: StrictStr,
+ application_request: ApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Application:
+ """core_applications_update
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param application_request: (required)
+ :type application_request: ApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_update_serialize(
+ slug=slug,
+ application_request=application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_update_with_http_info(
+ self,
+ slug: StrictStr,
+ application_request: ApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Application]:
+ """core_applications_update
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param application_request: (required)
+ :type application_request: ApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_update_serialize(
+ slug=slug,
+ application_request=application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_update_without_preload_content(
+ self,
+ slug: StrictStr,
+ application_request: ApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_update
+
+ Application Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param application_request: (required)
+ :type application_request: ApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_update_serialize(
+ slug=slug,
+ application_request=application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Application",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_update_serialize(
+ self,
+ slug,
+ application_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if application_request is not None:
+ _body_params = application_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/applications/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_applications_used_by_list(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_applications_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_applications_used_by_list_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_applications_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_applications_used_by_list_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_applications_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_applications_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_applications_used_by_list_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/applications/{slug}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_authenticated_sessions_bulk_delete_destroy(
+ self,
+ user_pks: Annotated[List[StrictInt], Field(description="List of user IDs to revoke all sessions for")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BulkDeleteSessionResponse:
+ """core_authenticated_sessions_bulk_delete_destroy
+
+ Bulk revoke all sessions for multiple users
+
+ :param user_pks: List of user IDs to revoke all sessions for (required)
+ :type user_pks: List[int]
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_bulk_delete_destroy_serialize(
+ user_pks=user_pks,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BulkDeleteSessionResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_authenticated_sessions_bulk_delete_destroy_with_http_info(
+ self,
+ user_pks: Annotated[List[StrictInt], Field(description="List of user IDs to revoke all sessions for")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BulkDeleteSessionResponse]:
+ """core_authenticated_sessions_bulk_delete_destroy
+
+ Bulk revoke all sessions for multiple users
+
+ :param user_pks: List of user IDs to revoke all sessions for (required)
+ :type user_pks: List[int]
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_bulk_delete_destroy_serialize(
+ user_pks=user_pks,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BulkDeleteSessionResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_authenticated_sessions_bulk_delete_destroy_without_preload_content(
+ self,
+ user_pks: Annotated[List[StrictInt], Field(description="List of user IDs to revoke all sessions for")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_authenticated_sessions_bulk_delete_destroy
+
+ Bulk revoke all sessions for multiple users
+
+ :param user_pks: List of user IDs to revoke all sessions for (required)
+ :type user_pks: List[int]
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_bulk_delete_destroy_serialize(
+ user_pks=user_pks,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BulkDeleteSessionResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_authenticated_sessions_bulk_delete_destroy_serialize(
+ self,
+ user_pks,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'user_pks': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if user_pks is not None:
+
+ _query_params.append(('user_pks', user_pks))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/authenticated_sessions/bulk_delete/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_authenticated_sessions_destroy(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_authenticated_sessions_destroy
+
+ AuthenticatedSession Viewset
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_authenticated_sessions_destroy_with_http_info(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_authenticated_sessions_destroy
+
+ AuthenticatedSession Viewset
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_authenticated_sessions_destroy_without_preload_content(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_authenticated_sessions_destroy
+
+ AuthenticatedSession Viewset
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_authenticated_sessions_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/authenticated_sessions/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_authenticated_sessions_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session__last_ip: Optional[StrictStr] = None,
+ session__last_user_agent: Optional[StrictStr] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedAuthenticatedSessionList:
+ """core_authenticated_sessions_list
+
+ AuthenticatedSession Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param session__last_ip:
+ :type session__last_ip: str
+ :param session__last_user_agent:
+ :type session__last_user_agent: str
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ session__last_ip=session__last_ip,
+ session__last_user_agent=session__last_user_agent,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAuthenticatedSessionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_authenticated_sessions_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session__last_ip: Optional[StrictStr] = None,
+ session__last_user_agent: Optional[StrictStr] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedAuthenticatedSessionList]:
+ """core_authenticated_sessions_list
+
+ AuthenticatedSession Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param session__last_ip:
+ :type session__last_ip: str
+ :param session__last_user_agent:
+ :type session__last_user_agent: str
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ session__last_ip=session__last_ip,
+ session__last_user_agent=session__last_user_agent,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAuthenticatedSessionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_authenticated_sessions_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session__last_ip: Optional[StrictStr] = None,
+ session__last_user_agent: Optional[StrictStr] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_authenticated_sessions_list
+
+ AuthenticatedSession Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param session__last_ip:
+ :type session__last_ip: str
+ :param session__last_user_agent:
+ :type session__last_user_agent: str
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ session__last_ip=session__last_ip,
+ session__last_user_agent=session__last_user_agent,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAuthenticatedSessionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_authenticated_sessions_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ search,
+ session__last_ip,
+ session__last_user_agent,
+ user__username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if session__last_ip is not None:
+
+ _query_params.append(('session__last_ip', session__last_ip))
+
+ if session__last_user_agent is not None:
+
+ _query_params.append(('session__last_user_agent', session__last_user_agent))
+
+ if user__username is not None:
+
+ _query_params.append(('user__username', user__username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/authenticated_sessions/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_authenticated_sessions_retrieve(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AuthenticatedSession:
+ """core_authenticated_sessions_retrieve
+
+ AuthenticatedSession Viewset
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AuthenticatedSession",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_authenticated_sessions_retrieve_with_http_info(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AuthenticatedSession]:
+ """core_authenticated_sessions_retrieve
+
+ AuthenticatedSession Viewset
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AuthenticatedSession",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_authenticated_sessions_retrieve_without_preload_content(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_authenticated_sessions_retrieve
+
+ AuthenticatedSession Viewset
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AuthenticatedSession",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_authenticated_sessions_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/authenticated_sessions/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_authenticated_sessions_used_by_list(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_authenticated_sessions_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_authenticated_sessions_used_by_list_with_http_info(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_authenticated_sessions_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_authenticated_sessions_used_by_list_without_preload_content(
+ self,
+ uuid: UUID,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_authenticated_sessions_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_authenticated_sessions_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_authenticated_sessions_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/authenticated_sessions/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_create(
+ self,
+ brand_request: BrandRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Brand:
+ """core_brands_create
+
+ Brand Viewset
+
+ :param brand_request: (required)
+ :type brand_request: BrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_create_serialize(
+ brand_request=brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_create_with_http_info(
+ self,
+ brand_request: BrandRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Brand]:
+ """core_brands_create
+
+ Brand Viewset
+
+ :param brand_request: (required)
+ :type brand_request: BrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_create_serialize(
+ brand_request=brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_create_without_preload_content(
+ self,
+ brand_request: BrandRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_create
+
+ Brand Viewset
+
+ :param brand_request: (required)
+ :type brand_request: BrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_create_serialize(
+ brand_request=brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_create_serialize(
+ self,
+ brand_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if brand_request is not None:
+ _body_params = brand_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/brands/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_current_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CurrentBrand:
+ """core_brands_current_retrieve
+
+ Get current brand
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_current_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CurrentBrand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_current_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CurrentBrand]:
+ """core_brands_current_retrieve
+
+ Get current brand
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_current_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CurrentBrand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_current_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_current_retrieve
+
+ Get current brand
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_current_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CurrentBrand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_current_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/brands/current/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_destroy(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_brands_destroy
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_destroy_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_destroy_with_http_info(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_brands_destroy
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_destroy_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_destroy_without_preload_content(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_destroy
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_destroy_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_destroy_serialize(
+ self,
+ brand_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if brand_uuid is not None:
+ _path_params['brand_uuid'] = brand_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/brands/{brand_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_list(
+ self,
+ brand_uuid: Optional[UUID] = None,
+ branding_default_flow_background: Optional[StrictStr] = None,
+ branding_favicon: Optional[StrictStr] = None,
+ branding_logo: Optional[StrictStr] = None,
+ branding_title: Optional[StrictStr] = None,
+ client_certificates: Optional[List[UUID]] = None,
+ default: Optional[StrictBool] = None,
+ domain: Optional[StrictStr] = None,
+ flow_authentication: Optional[UUID] = None,
+ flow_device_code: Optional[UUID] = None,
+ flow_invalidation: Optional[UUID] = None,
+ flow_lockdown: Optional[UUID] = None,
+ flow_recovery: Optional[UUID] = None,
+ flow_unenrollment: Optional[UUID] = None,
+ flow_user_settings: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ web_certificate: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedBrandList:
+ """core_brands_list
+
+ Brand Viewset
+
+ :param brand_uuid:
+ :type brand_uuid: UUID
+ :param branding_default_flow_background:
+ :type branding_default_flow_background: str
+ :param branding_favicon:
+ :type branding_favicon: str
+ :param branding_logo:
+ :type branding_logo: str
+ :param branding_title:
+ :type branding_title: str
+ :param client_certificates:
+ :type client_certificates: List[UUID]
+ :param default:
+ :type default: bool
+ :param domain:
+ :type domain: str
+ :param flow_authentication:
+ :type flow_authentication: UUID
+ :param flow_device_code:
+ :type flow_device_code: UUID
+ :param flow_invalidation:
+ :type flow_invalidation: UUID
+ :param flow_lockdown:
+ :type flow_lockdown: UUID
+ :param flow_recovery:
+ :type flow_recovery: UUID
+ :param flow_unenrollment:
+ :type flow_unenrollment: UUID
+ :param flow_user_settings:
+ :type flow_user_settings: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param web_certificate:
+ :type web_certificate: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_list_serialize(
+ brand_uuid=brand_uuid,
+ branding_default_flow_background=branding_default_flow_background,
+ branding_favicon=branding_favicon,
+ branding_logo=branding_logo,
+ branding_title=branding_title,
+ client_certificates=client_certificates,
+ default=default,
+ domain=domain,
+ flow_authentication=flow_authentication,
+ flow_device_code=flow_device_code,
+ flow_invalidation=flow_invalidation,
+ flow_lockdown=flow_lockdown,
+ flow_recovery=flow_recovery,
+ flow_unenrollment=flow_unenrollment,
+ flow_user_settings=flow_user_settings,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ web_certificate=web_certificate,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedBrandList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_list_with_http_info(
+ self,
+ brand_uuid: Optional[UUID] = None,
+ branding_default_flow_background: Optional[StrictStr] = None,
+ branding_favicon: Optional[StrictStr] = None,
+ branding_logo: Optional[StrictStr] = None,
+ branding_title: Optional[StrictStr] = None,
+ client_certificates: Optional[List[UUID]] = None,
+ default: Optional[StrictBool] = None,
+ domain: Optional[StrictStr] = None,
+ flow_authentication: Optional[UUID] = None,
+ flow_device_code: Optional[UUID] = None,
+ flow_invalidation: Optional[UUID] = None,
+ flow_lockdown: Optional[UUID] = None,
+ flow_recovery: Optional[UUID] = None,
+ flow_unenrollment: Optional[UUID] = None,
+ flow_user_settings: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ web_certificate: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedBrandList]:
+ """core_brands_list
+
+ Brand Viewset
+
+ :param brand_uuid:
+ :type brand_uuid: UUID
+ :param branding_default_flow_background:
+ :type branding_default_flow_background: str
+ :param branding_favicon:
+ :type branding_favicon: str
+ :param branding_logo:
+ :type branding_logo: str
+ :param branding_title:
+ :type branding_title: str
+ :param client_certificates:
+ :type client_certificates: List[UUID]
+ :param default:
+ :type default: bool
+ :param domain:
+ :type domain: str
+ :param flow_authentication:
+ :type flow_authentication: UUID
+ :param flow_device_code:
+ :type flow_device_code: UUID
+ :param flow_invalidation:
+ :type flow_invalidation: UUID
+ :param flow_lockdown:
+ :type flow_lockdown: UUID
+ :param flow_recovery:
+ :type flow_recovery: UUID
+ :param flow_unenrollment:
+ :type flow_unenrollment: UUID
+ :param flow_user_settings:
+ :type flow_user_settings: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param web_certificate:
+ :type web_certificate: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_list_serialize(
+ brand_uuid=brand_uuid,
+ branding_default_flow_background=branding_default_flow_background,
+ branding_favicon=branding_favicon,
+ branding_logo=branding_logo,
+ branding_title=branding_title,
+ client_certificates=client_certificates,
+ default=default,
+ domain=domain,
+ flow_authentication=flow_authentication,
+ flow_device_code=flow_device_code,
+ flow_invalidation=flow_invalidation,
+ flow_lockdown=flow_lockdown,
+ flow_recovery=flow_recovery,
+ flow_unenrollment=flow_unenrollment,
+ flow_user_settings=flow_user_settings,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ web_certificate=web_certificate,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedBrandList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_list_without_preload_content(
+ self,
+ brand_uuid: Optional[UUID] = None,
+ branding_default_flow_background: Optional[StrictStr] = None,
+ branding_favicon: Optional[StrictStr] = None,
+ branding_logo: Optional[StrictStr] = None,
+ branding_title: Optional[StrictStr] = None,
+ client_certificates: Optional[List[UUID]] = None,
+ default: Optional[StrictBool] = None,
+ domain: Optional[StrictStr] = None,
+ flow_authentication: Optional[UUID] = None,
+ flow_device_code: Optional[UUID] = None,
+ flow_invalidation: Optional[UUID] = None,
+ flow_lockdown: Optional[UUID] = None,
+ flow_recovery: Optional[UUID] = None,
+ flow_unenrollment: Optional[UUID] = None,
+ flow_user_settings: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ web_certificate: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_list
+
+ Brand Viewset
+
+ :param brand_uuid:
+ :type brand_uuid: UUID
+ :param branding_default_flow_background:
+ :type branding_default_flow_background: str
+ :param branding_favicon:
+ :type branding_favicon: str
+ :param branding_logo:
+ :type branding_logo: str
+ :param branding_title:
+ :type branding_title: str
+ :param client_certificates:
+ :type client_certificates: List[UUID]
+ :param default:
+ :type default: bool
+ :param domain:
+ :type domain: str
+ :param flow_authentication:
+ :type flow_authentication: UUID
+ :param flow_device_code:
+ :type flow_device_code: UUID
+ :param flow_invalidation:
+ :type flow_invalidation: UUID
+ :param flow_lockdown:
+ :type flow_lockdown: UUID
+ :param flow_recovery:
+ :type flow_recovery: UUID
+ :param flow_unenrollment:
+ :type flow_unenrollment: UUID
+ :param flow_user_settings:
+ :type flow_user_settings: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param web_certificate:
+ :type web_certificate: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_list_serialize(
+ brand_uuid=brand_uuid,
+ branding_default_flow_background=branding_default_flow_background,
+ branding_favicon=branding_favicon,
+ branding_logo=branding_logo,
+ branding_title=branding_title,
+ client_certificates=client_certificates,
+ default=default,
+ domain=domain,
+ flow_authentication=flow_authentication,
+ flow_device_code=flow_device_code,
+ flow_invalidation=flow_invalidation,
+ flow_lockdown=flow_lockdown,
+ flow_recovery=flow_recovery,
+ flow_unenrollment=flow_unenrollment,
+ flow_user_settings=flow_user_settings,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ web_certificate=web_certificate,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedBrandList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_list_serialize(
+ self,
+ brand_uuid,
+ branding_default_flow_background,
+ branding_favicon,
+ branding_logo,
+ branding_title,
+ client_certificates,
+ default,
+ domain,
+ flow_authentication,
+ flow_device_code,
+ flow_invalidation,
+ flow_lockdown,
+ flow_recovery,
+ flow_unenrollment,
+ flow_user_settings,
+ ordering,
+ page,
+ page_size,
+ search,
+ web_certificate,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'client_certificates': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if brand_uuid is not None:
+
+ _query_params.append(('brand_uuid', brand_uuid))
+
+ if branding_default_flow_background is not None:
+
+ _query_params.append(('branding_default_flow_background', branding_default_flow_background))
+
+ if branding_favicon is not None:
+
+ _query_params.append(('branding_favicon', branding_favicon))
+
+ if branding_logo is not None:
+
+ _query_params.append(('branding_logo', branding_logo))
+
+ if branding_title is not None:
+
+ _query_params.append(('branding_title', branding_title))
+
+ if client_certificates is not None:
+
+ _query_params.append(('client_certificates', client_certificates))
+
+ if default is not None:
+
+ _query_params.append(('default', default))
+
+ if domain is not None:
+
+ _query_params.append(('domain', domain))
+
+ if flow_authentication is not None:
+
+ _query_params.append(('flow_authentication', flow_authentication))
+
+ if flow_device_code is not None:
+
+ _query_params.append(('flow_device_code', flow_device_code))
+
+ if flow_invalidation is not None:
+
+ _query_params.append(('flow_invalidation', flow_invalidation))
+
+ if flow_lockdown is not None:
+
+ _query_params.append(('flow_lockdown', flow_lockdown))
+
+ if flow_recovery is not None:
+
+ _query_params.append(('flow_recovery', flow_recovery))
+
+ if flow_unenrollment is not None:
+
+ _query_params.append(('flow_unenrollment', flow_unenrollment))
+
+ if flow_user_settings is not None:
+
+ _query_params.append(('flow_user_settings', flow_user_settings))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if web_certificate is not None:
+
+ _query_params.append(('web_certificate', web_certificate))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/brands/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_partial_update(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ patched_brand_request: Optional[PatchedBrandRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Brand:
+ """core_brands_partial_update
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param patched_brand_request:
+ :type patched_brand_request: PatchedBrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_partial_update_serialize(
+ brand_uuid=brand_uuid,
+ patched_brand_request=patched_brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_partial_update_with_http_info(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ patched_brand_request: Optional[PatchedBrandRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Brand]:
+ """core_brands_partial_update
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param patched_brand_request:
+ :type patched_brand_request: PatchedBrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_partial_update_serialize(
+ brand_uuid=brand_uuid,
+ patched_brand_request=patched_brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_partial_update_without_preload_content(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ patched_brand_request: Optional[PatchedBrandRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_partial_update
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param patched_brand_request:
+ :type patched_brand_request: PatchedBrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_partial_update_serialize(
+ brand_uuid=brand_uuid,
+ patched_brand_request=patched_brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_partial_update_serialize(
+ self,
+ brand_uuid,
+ patched_brand_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if brand_uuid is not None:
+ _path_params['brand_uuid'] = brand_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_brand_request is not None:
+ _body_params = patched_brand_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/core/brands/{brand_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_retrieve(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Brand:
+ """core_brands_retrieve
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_retrieve_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_retrieve_with_http_info(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Brand]:
+ """core_brands_retrieve
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_retrieve_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_retrieve_without_preload_content(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_retrieve
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_retrieve_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_retrieve_serialize(
+ self,
+ brand_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if brand_uuid is not None:
+ _path_params['brand_uuid'] = brand_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/brands/{brand_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_update(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ brand_request: BrandRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Brand:
+ """core_brands_update
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param brand_request: (required)
+ :type brand_request: BrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_update_serialize(
+ brand_uuid=brand_uuid,
+ brand_request=brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_update_with_http_info(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ brand_request: BrandRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Brand]:
+ """core_brands_update
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param brand_request: (required)
+ :type brand_request: BrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_update_serialize(
+ brand_uuid=brand_uuid,
+ brand_request=brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_update_without_preload_content(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ brand_request: BrandRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_update
+
+ Brand Viewset
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param brand_request: (required)
+ :type brand_request: BrandRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_update_serialize(
+ brand_uuid=brand_uuid,
+ brand_request=brand_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Brand",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_update_serialize(
+ self,
+ brand_uuid,
+ brand_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if brand_uuid is not None:
+ _path_params['brand_uuid'] = brand_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if brand_request is not None:
+ _body_params = brand_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/brands/{brand_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_brands_used_by_list(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_brands_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_used_by_list_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_brands_used_by_list_with_http_info(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_brands_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_used_by_list_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_brands_used_by_list_without_preload_content(
+ self,
+ brand_uuid: Annotated[UUID, Field(description="A UUID string identifying this Brand.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_brands_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param brand_uuid: A UUID string identifying this Brand. (required)
+ :type brand_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_brands_used_by_list_serialize(
+ brand_uuid=brand_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_brands_used_by_list_serialize(
+ self,
+ brand_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if brand_uuid is not None:
+ _path_params['brand_uuid'] = brand_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/brands/{brand_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_add_user_create(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ user_account_request: UserAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_groups_add_user_create
+
+ Add user to group
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param user_account_request: (required)
+ :type user_account_request: UserAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_add_user_create_serialize(
+ group_uuid=group_uuid,
+ user_account_request=user_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_add_user_create_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ user_account_request: UserAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_groups_add_user_create
+
+ Add user to group
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param user_account_request: (required)
+ :type user_account_request: UserAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_add_user_create_serialize(
+ group_uuid=group_uuid,
+ user_account_request=user_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_add_user_create_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ user_account_request: UserAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_add_user_create
+
+ Add user to group
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param user_account_request: (required)
+ :type user_account_request: UserAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_add_user_create_serialize(
+ group_uuid=group_uuid,
+ user_account_request=user_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_add_user_create_serialize(
+ self,
+ group_uuid,
+ user_account_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_account_request is not None:
+ _body_params = user_account_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/groups/{group_uuid}/add_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_create(
+ self,
+ group_request: GroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Group:
+ """core_groups_create
+
+ Group Viewset
+
+ :param group_request: (required)
+ :type group_request: GroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_create_serialize(
+ group_request=group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_create_with_http_info(
+ self,
+ group_request: GroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Group]:
+ """core_groups_create
+
+ Group Viewset
+
+ :param group_request: (required)
+ :type group_request: GroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_create_serialize(
+ group_request=group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_create_without_preload_content(
+ self,
+ group_request: GroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_create
+
+ Group Viewset
+
+ :param group_request: (required)
+ :type group_request: GroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_create_serialize(
+ group_request=group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_create_serialize(
+ self,
+ group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_request is not None:
+ _body_params = group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_destroy(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_groups_destroy
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_destroy_serialize(
+ group_uuid=group_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_destroy_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_groups_destroy
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_destroy_serialize(
+ group_uuid=group_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_destroy_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_destroy
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_destroy_serialize(
+ group_uuid=group_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_destroy_serialize(
+ self,
+ group_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/groups/{group_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_list(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ include_children: Optional[StrictBool] = None,
+ include_inherited_roles: Optional[StrictBool] = None,
+ include_parents: Optional[StrictBool] = None,
+ include_users: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ members_by_pk: Optional[List[StrictInt]] = None,
+ members_by_username: Annotated[Optional[List[StrictStr]], Field(description="Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.")] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGroupList:
+ """core_groups_list
+
+ Group Viewset
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param include_children:
+ :type include_children: bool
+ :param include_inherited_roles:
+ :type include_inherited_roles: bool
+ :param include_parents:
+ :type include_parents: bool
+ :param include_users:
+ :type include_users: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param members_by_pk:
+ :type members_by_pk: List[int]
+ :param members_by_username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+ :type members_by_username: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_list_serialize(
+ attributes=attributes,
+ include_children=include_children,
+ include_inherited_roles=include_inherited_roles,
+ include_parents=include_parents,
+ include_users=include_users,
+ is_superuser=is_superuser,
+ members_by_pk=members_by_pk,
+ members_by_username=members_by_username,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_list_with_http_info(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ include_children: Optional[StrictBool] = None,
+ include_inherited_roles: Optional[StrictBool] = None,
+ include_parents: Optional[StrictBool] = None,
+ include_users: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ members_by_pk: Optional[List[StrictInt]] = None,
+ members_by_username: Annotated[Optional[List[StrictStr]], Field(description="Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.")] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGroupList]:
+ """core_groups_list
+
+ Group Viewset
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param include_children:
+ :type include_children: bool
+ :param include_inherited_roles:
+ :type include_inherited_roles: bool
+ :param include_parents:
+ :type include_parents: bool
+ :param include_users:
+ :type include_users: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param members_by_pk:
+ :type members_by_pk: List[int]
+ :param members_by_username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+ :type members_by_username: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_list_serialize(
+ attributes=attributes,
+ include_children=include_children,
+ include_inherited_roles=include_inherited_roles,
+ include_parents=include_parents,
+ include_users=include_users,
+ is_superuser=is_superuser,
+ members_by_pk=members_by_pk,
+ members_by_username=members_by_username,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_list_without_preload_content(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ include_children: Optional[StrictBool] = None,
+ include_inherited_roles: Optional[StrictBool] = None,
+ include_parents: Optional[StrictBool] = None,
+ include_users: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ members_by_pk: Optional[List[StrictInt]] = None,
+ members_by_username: Annotated[Optional[List[StrictStr]], Field(description="Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.")] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_list
+
+ Group Viewset
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param include_children:
+ :type include_children: bool
+ :param include_inherited_roles:
+ :type include_inherited_roles: bool
+ :param include_parents:
+ :type include_parents: bool
+ :param include_users:
+ :type include_users: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param members_by_pk:
+ :type members_by_pk: List[int]
+ :param members_by_username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+ :type members_by_username: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_list_serialize(
+ attributes=attributes,
+ include_children=include_children,
+ include_inherited_roles=include_inherited_roles,
+ include_parents=include_parents,
+ include_users=include_users,
+ is_superuser=is_superuser,
+ members_by_pk=members_by_pk,
+ members_by_username=members_by_username,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_list_serialize(
+ self,
+ attributes,
+ include_children,
+ include_inherited_roles,
+ include_parents,
+ include_users,
+ is_superuser,
+ members_by_pk,
+ members_by_username,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'members_by_pk': 'multi',
+ 'members_by_username': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if attributes is not None:
+
+ _query_params.append(('attributes', attributes))
+
+ if include_children is not None:
+
+ _query_params.append(('include_children', include_children))
+
+ if include_inherited_roles is not None:
+
+ _query_params.append(('include_inherited_roles', include_inherited_roles))
+
+ if include_parents is not None:
+
+ _query_params.append(('include_parents', include_parents))
+
+ if include_users is not None:
+
+ _query_params.append(('include_users', include_users))
+
+ if is_superuser is not None:
+
+ _query_params.append(('is_superuser', is_superuser))
+
+ if members_by_pk is not None:
+
+ _query_params.append(('members_by_pk', members_by_pk))
+
+ if members_by_username is not None:
+
+ _query_params.append(('members_by_username', members_by_username))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_partial_update(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ patched_group_request: Optional[PatchedGroupRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Group:
+ """core_groups_partial_update
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param patched_group_request:
+ :type patched_group_request: PatchedGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_partial_update_serialize(
+ group_uuid=group_uuid,
+ patched_group_request=patched_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_partial_update_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ patched_group_request: Optional[PatchedGroupRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Group]:
+ """core_groups_partial_update
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param patched_group_request:
+ :type patched_group_request: PatchedGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_partial_update_serialize(
+ group_uuid=group_uuid,
+ patched_group_request=patched_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_partial_update_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ patched_group_request: Optional[PatchedGroupRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_partial_update
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param patched_group_request:
+ :type patched_group_request: PatchedGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_partial_update_serialize(
+ group_uuid=group_uuid,
+ patched_group_request=patched_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_partial_update_serialize(
+ self,
+ group_uuid,
+ patched_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_group_request is not None:
+ _body_params = patched_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/core/groups/{group_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_remove_user_create(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ user_account_request: UserAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_groups_remove_user_create
+
+ Remove user from group
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param user_account_request: (required)
+ :type user_account_request: UserAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_remove_user_create_serialize(
+ group_uuid=group_uuid,
+ user_account_request=user_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_remove_user_create_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ user_account_request: UserAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_groups_remove_user_create
+
+ Remove user from group
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param user_account_request: (required)
+ :type user_account_request: UserAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_remove_user_create_serialize(
+ group_uuid=group_uuid,
+ user_account_request=user_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_remove_user_create_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ user_account_request: UserAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_remove_user_create
+
+ Remove user from group
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param user_account_request: (required)
+ :type user_account_request: UserAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_remove_user_create_serialize(
+ group_uuid=group_uuid,
+ user_account_request=user_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_remove_user_create_serialize(
+ self,
+ group_uuid,
+ user_account_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_account_request is not None:
+ _body_params = user_account_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/groups/{group_uuid}/remove_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_retrieve(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ include_children: Optional[StrictBool] = None,
+ include_inherited_roles: Optional[StrictBool] = None,
+ include_parents: Optional[StrictBool] = None,
+ include_users: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Group:
+ """core_groups_retrieve
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param include_children:
+ :type include_children: bool
+ :param include_inherited_roles:
+ :type include_inherited_roles: bool
+ :param include_parents:
+ :type include_parents: bool
+ :param include_users:
+ :type include_users: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_retrieve_serialize(
+ group_uuid=group_uuid,
+ include_children=include_children,
+ include_inherited_roles=include_inherited_roles,
+ include_parents=include_parents,
+ include_users=include_users,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_retrieve_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ include_children: Optional[StrictBool] = None,
+ include_inherited_roles: Optional[StrictBool] = None,
+ include_parents: Optional[StrictBool] = None,
+ include_users: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Group]:
+ """core_groups_retrieve
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param include_children:
+ :type include_children: bool
+ :param include_inherited_roles:
+ :type include_inherited_roles: bool
+ :param include_parents:
+ :type include_parents: bool
+ :param include_users:
+ :type include_users: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_retrieve_serialize(
+ group_uuid=group_uuid,
+ include_children=include_children,
+ include_inherited_roles=include_inherited_roles,
+ include_parents=include_parents,
+ include_users=include_users,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_retrieve_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ include_children: Optional[StrictBool] = None,
+ include_inherited_roles: Optional[StrictBool] = None,
+ include_parents: Optional[StrictBool] = None,
+ include_users: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_retrieve
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param include_children:
+ :type include_children: bool
+ :param include_inherited_roles:
+ :type include_inherited_roles: bool
+ :param include_parents:
+ :type include_parents: bool
+ :param include_users:
+ :type include_users: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_retrieve_serialize(
+ group_uuid=group_uuid,
+ include_children=include_children,
+ include_inherited_roles=include_inherited_roles,
+ include_parents=include_parents,
+ include_users=include_users,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_retrieve_serialize(
+ self,
+ group_uuid,
+ include_children,
+ include_inherited_roles,
+ include_parents,
+ include_users,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ if include_children is not None:
+
+ _query_params.append(('include_children', include_children))
+
+ if include_inherited_roles is not None:
+
+ _query_params.append(('include_inherited_roles', include_inherited_roles))
+
+ if include_parents is not None:
+
+ _query_params.append(('include_parents', include_parents))
+
+ if include_users is not None:
+
+ _query_params.append(('include_users', include_users))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/groups/{group_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_update(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ group_request: GroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Group:
+ """core_groups_update
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param group_request: (required)
+ :type group_request: GroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_update_serialize(
+ group_uuid=group_uuid,
+ group_request=group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_update_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ group_request: GroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Group]:
+ """core_groups_update
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param group_request: (required)
+ :type group_request: GroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_update_serialize(
+ group_uuid=group_uuid,
+ group_request=group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_update_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ group_request: GroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_update
+
+ Group Viewset
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param group_request: (required)
+ :type group_request: GroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_update_serialize(
+ group_uuid=group_uuid,
+ group_request=group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Group",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_update_serialize(
+ self,
+ group_uuid,
+ group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_request is not None:
+ _body_params = group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/groups/{group_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_groups_used_by_list(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_used_by_list_serialize(
+ group_uuid=group_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_groups_used_by_list_with_http_info(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_used_by_list_serialize(
+ group_uuid=group_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_groups_used_by_list_without_preload_content(
+ self,
+ group_uuid: Annotated[UUID, Field(description="A UUID string identifying this Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param group_uuid: A UUID string identifying this Group. (required)
+ :type group_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_groups_used_by_list_serialize(
+ group_uuid=group_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_groups_used_by_list_serialize(
+ self,
+ group_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if group_uuid is not None:
+ _path_params['group_uuid'] = group_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/groups/{group_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_create(
+ self,
+ token_request: TokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Token:
+ """core_tokens_create
+
+ Token Viewset
+
+ :param token_request: (required)
+ :type token_request: TokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_create_serialize(
+ token_request=token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_create_with_http_info(
+ self,
+ token_request: TokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Token]:
+ """core_tokens_create
+
+ Token Viewset
+
+ :param token_request: (required)
+ :type token_request: TokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_create_serialize(
+ token_request=token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_create_without_preload_content(
+ self,
+ token_request: TokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_create
+
+ Token Viewset
+
+ :param token_request: (required)
+ :type token_request: TokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_create_serialize(
+ token_request=token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_create_serialize(
+ self,
+ token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if token_request is not None:
+ _body_params = token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_destroy(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_tokens_destroy
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_destroy_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_destroy_with_http_info(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_tokens_destroy
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_destroy_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_destroy_without_preload_content(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_destroy
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_destroy_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_destroy_serialize(
+ self,
+ identifier,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/tokens/{identifier}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_list(
+ self,
+ description: Optional[StrictStr] = None,
+ expires: Optional[datetime] = None,
+ expiring: Optional[StrictBool] = None,
+ identifier: Optional[StrictStr] = None,
+ intent: Optional[IntentEnum] = None,
+ managed: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedTokenList:
+ """core_tokens_list
+
+ Token Viewset
+
+ :param description:
+ :type description: str
+ :param expires:
+ :type expires: datetime
+ :param expiring:
+ :type expiring: bool
+ :param identifier:
+ :type identifier: str
+ :param intent:
+ :type intent: IntentEnum
+ :param managed:
+ :type managed: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_list_serialize(
+ description=description,
+ expires=expires,
+ expiring=expiring,
+ identifier=identifier,
+ intent=intent,
+ managed=managed,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_list_with_http_info(
+ self,
+ description: Optional[StrictStr] = None,
+ expires: Optional[datetime] = None,
+ expiring: Optional[StrictBool] = None,
+ identifier: Optional[StrictStr] = None,
+ intent: Optional[IntentEnum] = None,
+ managed: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedTokenList]:
+ """core_tokens_list
+
+ Token Viewset
+
+ :param description:
+ :type description: str
+ :param expires:
+ :type expires: datetime
+ :param expiring:
+ :type expiring: bool
+ :param identifier:
+ :type identifier: str
+ :param intent:
+ :type intent: IntentEnum
+ :param managed:
+ :type managed: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_list_serialize(
+ description=description,
+ expires=expires,
+ expiring=expiring,
+ identifier=identifier,
+ intent=intent,
+ managed=managed,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_list_without_preload_content(
+ self,
+ description: Optional[StrictStr] = None,
+ expires: Optional[datetime] = None,
+ expiring: Optional[StrictBool] = None,
+ identifier: Optional[StrictStr] = None,
+ intent: Optional[IntentEnum] = None,
+ managed: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_list
+
+ Token Viewset
+
+ :param description:
+ :type description: str
+ :param expires:
+ :type expires: datetime
+ :param expiring:
+ :type expiring: bool
+ :param identifier:
+ :type identifier: str
+ :param intent:
+ :type intent: IntentEnum
+ :param managed:
+ :type managed: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_list_serialize(
+ description=description,
+ expires=expires,
+ expiring=expiring,
+ identifier=identifier,
+ intent=intent,
+ managed=managed,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_list_serialize(
+ self,
+ description,
+ expires,
+ expiring,
+ identifier,
+ intent,
+ managed,
+ ordering,
+ page,
+ page_size,
+ search,
+ user__username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if description is not None:
+
+ _query_params.append(('description', description))
+
+ if expires is not None:
+ if isinstance(expires, datetime):
+ _query_params.append(
+ (
+ 'expires',
+ expires.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('expires', expires))
+
+ if expiring is not None:
+
+ _query_params.append(('expiring', expiring))
+
+ if identifier is not None:
+
+ _query_params.append(('identifier', identifier))
+
+ if intent is not None:
+
+ _query_params.append(('intent', intent.value))
+
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user__username is not None:
+
+ _query_params.append(('user__username', user__username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_partial_update(
+ self,
+ identifier: StrictStr,
+ patched_token_request: Optional[PatchedTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Token:
+ """core_tokens_partial_update
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param patched_token_request:
+ :type patched_token_request: PatchedTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_partial_update_serialize(
+ identifier=identifier,
+ patched_token_request=patched_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_partial_update_with_http_info(
+ self,
+ identifier: StrictStr,
+ patched_token_request: Optional[PatchedTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Token]:
+ """core_tokens_partial_update
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param patched_token_request:
+ :type patched_token_request: PatchedTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_partial_update_serialize(
+ identifier=identifier,
+ patched_token_request=patched_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_partial_update_without_preload_content(
+ self,
+ identifier: StrictStr,
+ patched_token_request: Optional[PatchedTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_partial_update
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param patched_token_request:
+ :type patched_token_request: PatchedTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_partial_update_serialize(
+ identifier=identifier,
+ patched_token_request=patched_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_partial_update_serialize(
+ self,
+ identifier,
+ patched_token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_token_request is not None:
+ _body_params = patched_token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/core/tokens/{identifier}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_retrieve(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Token:
+ """core_tokens_retrieve
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_retrieve_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_retrieve_with_http_info(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Token]:
+ """core_tokens_retrieve
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_retrieve_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_retrieve_without_preload_content(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_retrieve
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_retrieve_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_retrieve_serialize(
+ self,
+ identifier,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/tokens/{identifier}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_set_key_create(
+ self,
+ identifier: StrictStr,
+ token_set_key_request: TokenSetKeyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_tokens_set_key_create
+
+ Set token key. Action is logged as event. `authentik_core.set_token_key` permission is required.
+
+ :param identifier: (required)
+ :type identifier: str
+ :param token_set_key_request: (required)
+ :type token_set_key_request: TokenSetKeyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_set_key_create_serialize(
+ identifier=identifier,
+ token_set_key_request=token_set_key_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '404': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_set_key_create_with_http_info(
+ self,
+ identifier: StrictStr,
+ token_set_key_request: TokenSetKeyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_tokens_set_key_create
+
+ Set token key. Action is logged as event. `authentik_core.set_token_key` permission is required.
+
+ :param identifier: (required)
+ :type identifier: str
+ :param token_set_key_request: (required)
+ :type token_set_key_request: TokenSetKeyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_set_key_create_serialize(
+ identifier=identifier,
+ token_set_key_request=token_set_key_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '404': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_set_key_create_without_preload_content(
+ self,
+ identifier: StrictStr,
+ token_set_key_request: TokenSetKeyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_set_key_create
+
+ Set token key. Action is logged as event. `authentik_core.set_token_key` permission is required.
+
+ :param identifier: (required)
+ :type identifier: str
+ :param token_set_key_request: (required)
+ :type token_set_key_request: TokenSetKeyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_set_key_create_serialize(
+ identifier=identifier,
+ token_set_key_request=token_set_key_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '404': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_set_key_create_serialize(
+ self,
+ identifier,
+ token_set_key_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if token_set_key_request is not None:
+ _body_params = token_set_key_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/tokens/{identifier}/set_key/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_update(
+ self,
+ identifier: StrictStr,
+ token_request: TokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Token:
+ """core_tokens_update
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param token_request: (required)
+ :type token_request: TokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_update_serialize(
+ identifier=identifier,
+ token_request=token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_update_with_http_info(
+ self,
+ identifier: StrictStr,
+ token_request: TokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Token]:
+ """core_tokens_update
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param token_request: (required)
+ :type token_request: TokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_update_serialize(
+ identifier=identifier,
+ token_request=token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_update_without_preload_content(
+ self,
+ identifier: StrictStr,
+ token_request: TokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_update
+
+ Token Viewset
+
+ :param identifier: (required)
+ :type identifier: str
+ :param token_request: (required)
+ :type token_request: TokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_update_serialize(
+ identifier=identifier,
+ token_request=token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Token",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_update_serialize(
+ self,
+ identifier,
+ token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if token_request is not None:
+ _body_params = token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/tokens/{identifier}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_used_by_list(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_used_by_list_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_used_by_list_with_http_info(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_used_by_list_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_used_by_list_without_preload_content(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_used_by_list_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_used_by_list_serialize(
+ self,
+ identifier,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/tokens/{identifier}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_tokens_view_key_retrieve(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TokenView:
+ """core_tokens_view_key_retrieve
+
+ Return token key and log access
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_view_key_retrieve_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenView",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_tokens_view_key_retrieve_with_http_info(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TokenView]:
+ """core_tokens_view_key_retrieve
+
+ Return token key and log access
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_view_key_retrieve_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenView",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_tokens_view_key_retrieve_without_preload_content(
+ self,
+ identifier: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_tokens_view_key_retrieve
+
+ Return token key and log access
+
+ :param identifier: (required)
+ :type identifier: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_tokens_view_key_retrieve_serialize(
+ identifier=identifier,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenView",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_tokens_view_key_retrieve_serialize(
+ self,
+ identifier,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if identifier is not None:
+ _path_params['identifier'] = identifier
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/tokens/{identifier}/view_key/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_transactional_applications_update(
+ self,
+ transaction_application_request: TransactionApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TransactionApplicationResponse:
+ """core_transactional_applications_update
+
+ Convert data into a blueprint, validate it and apply it
+
+ :param transaction_application_request: (required)
+ :type transaction_application_request: TransactionApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_transactional_applications_update_serialize(
+ transaction_application_request=transaction_application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TransactionApplicationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_transactional_applications_update_with_http_info(
+ self,
+ transaction_application_request: TransactionApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TransactionApplicationResponse]:
+ """core_transactional_applications_update
+
+ Convert data into a blueprint, validate it and apply it
+
+ :param transaction_application_request: (required)
+ :type transaction_application_request: TransactionApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_transactional_applications_update_serialize(
+ transaction_application_request=transaction_application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TransactionApplicationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_transactional_applications_update_without_preload_content(
+ self,
+ transaction_application_request: TransactionApplicationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_transactional_applications_update
+
+ Convert data into a blueprint, validate it and apply it
+
+ :param transaction_application_request: (required)
+ :type transaction_application_request: TransactionApplicationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_transactional_applications_update_serialize(
+ transaction_application_request=transaction_application_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TransactionApplicationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_transactional_applications_update_serialize(
+ self,
+ transaction_application_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if transaction_application_request is not None:
+ _body_params = transaction_application_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/transactional/applications/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_user_consent_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_user_consent_destroy
+
+ UserConsent Viewset
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_user_consent_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_user_consent_destroy
+
+ UserConsent Viewset
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_user_consent_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_user_consent_destroy
+
+ UserConsent Viewset
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_user_consent_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/user_consent/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_user_consent_list(
+ self,
+ application: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedUserConsentList:
+ """core_user_consent_list
+
+ UserConsent Viewset
+
+ :param application:
+ :type application: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_list_serialize(
+ application=application,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUserConsentList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_user_consent_list_with_http_info(
+ self,
+ application: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedUserConsentList]:
+ """core_user_consent_list
+
+ UserConsent Viewset
+
+ :param application:
+ :type application: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_list_serialize(
+ application=application,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUserConsentList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_user_consent_list_without_preload_content(
+ self,
+ application: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_user_consent_list
+
+ UserConsent Viewset
+
+ :param application:
+ :type application: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_list_serialize(
+ application=application,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUserConsentList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_user_consent_list_serialize(
+ self,
+ application,
+ ordering,
+ page,
+ page_size,
+ search,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application is not None:
+
+ _query_params.append(('application', application))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/user_consent/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_user_consent_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UserConsent:
+ """core_user_consent_retrieve
+
+ UserConsent Viewset
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserConsent",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_user_consent_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UserConsent]:
+ """core_user_consent_retrieve
+
+ UserConsent Viewset
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserConsent",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_user_consent_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_user_consent_retrieve
+
+ UserConsent Viewset
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserConsent",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_user_consent_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/user_consent/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_user_consent_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_user_consent_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_user_consent_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_user_consent_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_user_consent_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User Consent.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_user_consent_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this User Consent. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_user_consent_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_user_consent_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/user_consent/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_account_lockdown_create(
+ self,
+ user_account_lockdown_request: Optional[UserAccountLockdownRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Link:
+ """core_users_account_lockdown_create
+
+ Choose the target account, then return a flow link.
+
+ :param user_account_lockdown_request:
+ :type user_account_lockdown_request: UserAccountLockdownRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_account_lockdown_create_serialize(
+ user_account_lockdown_request=user_account_lockdown_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': None,
+ '403': None,
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_account_lockdown_create_with_http_info(
+ self,
+ user_account_lockdown_request: Optional[UserAccountLockdownRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Link]:
+ """core_users_account_lockdown_create
+
+ Choose the target account, then return a flow link.
+
+ :param user_account_lockdown_request:
+ :type user_account_lockdown_request: UserAccountLockdownRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_account_lockdown_create_serialize(
+ user_account_lockdown_request=user_account_lockdown_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': None,
+ '403': None,
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_account_lockdown_create_without_preload_content(
+ self,
+ user_account_lockdown_request: Optional[UserAccountLockdownRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_account_lockdown_create
+
+ Choose the target account, then return a flow link.
+
+ :param user_account_lockdown_request:
+ :type user_account_lockdown_request: UserAccountLockdownRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_account_lockdown_create_serialize(
+ user_account_lockdown_request=user_account_lockdown_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': None,
+ '403': None,
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_account_lockdown_create_serialize(
+ self,
+ user_account_lockdown_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_account_lockdown_request is not None:
+ _body_params = user_account_lockdown_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/account_lockdown/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_create(
+ self,
+ user_request: UserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> User:
+ """core_users_create
+
+ User Viewset
+
+ :param user_request: (required)
+ :type user_request: UserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_create_serialize(
+ user_request=user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_create_with_http_info(
+ self,
+ user_request: UserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[User]:
+ """core_users_create
+
+ User Viewset
+
+ :param user_request: (required)
+ :type user_request: UserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_create_serialize(
+ user_request=user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_create_without_preload_content(
+ self,
+ user_request: UserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_create
+
+ User Viewset
+
+ :param user_request: (required)
+ :type user_request: UserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_create_serialize(
+ user_request=user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_create_serialize(
+ self,
+ user_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_request is not None:
+ _body_params = user_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_users_destroy
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_users_destroy
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_destroy
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/core/users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_export_create(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ date_joined: Optional[datetime] = None,
+ date_joined__gt: Optional[datetime] = None,
+ date_joined__lt: Optional[datetime] = None,
+ email: Optional[StrictStr] = None,
+ groups_by_name: Optional[List[StrictStr]] = None,
+ groups_by_pk: Optional[List[UUID]] = None,
+ is_active: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ last_login: Optional[datetime] = None,
+ last_login__gt: Optional[datetime] = None,
+ last_login__isnull: Optional[StrictBool] = None,
+ last_login__lt: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ last_updated__gt: Optional[datetime] = None,
+ last_updated__lt: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ path: Optional[StrictStr] = None,
+ path_startswith: Optional[StrictStr] = None,
+ roles_by_name: Optional[List[StrictStr]] = None,
+ roles_by_pk: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ type: Optional[List[UserTypeEnum]] = None,
+ username: Optional[StrictStr] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DataExport:
+ """core_users_export_create
+
+ Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param date_joined:
+ :type date_joined: datetime
+ :param date_joined__gt:
+ :type date_joined__gt: datetime
+ :param date_joined__lt:
+ :type date_joined__lt: datetime
+ :param email:
+ :type email: str
+ :param groups_by_name:
+ :type groups_by_name: List[str]
+ :param groups_by_pk:
+ :type groups_by_pk: List[UUID]
+ :param is_active:
+ :type is_active: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param last_login:
+ :type last_login: datetime
+ :param last_login__gt:
+ :type last_login__gt: datetime
+ :param last_login__isnull:
+ :type last_login__isnull: bool
+ :param last_login__lt:
+ :type last_login__lt: datetime
+ :param last_updated:
+ :type last_updated: datetime
+ :param last_updated__gt:
+ :type last_updated__gt: datetime
+ :param last_updated__lt:
+ :type last_updated__lt: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param path:
+ :type path: str
+ :param path_startswith:
+ :type path_startswith: str
+ :param roles_by_name:
+ :type roles_by_name: List[str]
+ :param roles_by_pk:
+ :type roles_by_pk: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param type:
+ :type type: List[UserTypeEnum]
+ :param username:
+ :type username: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_export_create_serialize(
+ attributes=attributes,
+ date_joined=date_joined,
+ date_joined__gt=date_joined__gt,
+ date_joined__lt=date_joined__lt,
+ email=email,
+ groups_by_name=groups_by_name,
+ groups_by_pk=groups_by_pk,
+ is_active=is_active,
+ is_superuser=is_superuser,
+ last_login=last_login,
+ last_login__gt=last_login__gt,
+ last_login__isnull=last_login__isnull,
+ last_login__lt=last_login__lt,
+ last_updated=last_updated,
+ last_updated__gt=last_updated__gt,
+ last_updated__lt=last_updated__lt,
+ name=name,
+ ordering=ordering,
+ path=path,
+ path_startswith=path_startswith,
+ roles_by_name=roles_by_name,
+ roles_by_pk=roles_by_pk,
+ search=search,
+ type=type,
+ username=username,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_export_create_with_http_info(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ date_joined: Optional[datetime] = None,
+ date_joined__gt: Optional[datetime] = None,
+ date_joined__lt: Optional[datetime] = None,
+ email: Optional[StrictStr] = None,
+ groups_by_name: Optional[List[StrictStr]] = None,
+ groups_by_pk: Optional[List[UUID]] = None,
+ is_active: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ last_login: Optional[datetime] = None,
+ last_login__gt: Optional[datetime] = None,
+ last_login__isnull: Optional[StrictBool] = None,
+ last_login__lt: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ last_updated__gt: Optional[datetime] = None,
+ last_updated__lt: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ path: Optional[StrictStr] = None,
+ path_startswith: Optional[StrictStr] = None,
+ roles_by_name: Optional[List[StrictStr]] = None,
+ roles_by_pk: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ type: Optional[List[UserTypeEnum]] = None,
+ username: Optional[StrictStr] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DataExport]:
+ """core_users_export_create
+
+ Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param date_joined:
+ :type date_joined: datetime
+ :param date_joined__gt:
+ :type date_joined__gt: datetime
+ :param date_joined__lt:
+ :type date_joined__lt: datetime
+ :param email:
+ :type email: str
+ :param groups_by_name:
+ :type groups_by_name: List[str]
+ :param groups_by_pk:
+ :type groups_by_pk: List[UUID]
+ :param is_active:
+ :type is_active: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param last_login:
+ :type last_login: datetime
+ :param last_login__gt:
+ :type last_login__gt: datetime
+ :param last_login__isnull:
+ :type last_login__isnull: bool
+ :param last_login__lt:
+ :type last_login__lt: datetime
+ :param last_updated:
+ :type last_updated: datetime
+ :param last_updated__gt:
+ :type last_updated__gt: datetime
+ :param last_updated__lt:
+ :type last_updated__lt: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param path:
+ :type path: str
+ :param path_startswith:
+ :type path_startswith: str
+ :param roles_by_name:
+ :type roles_by_name: List[str]
+ :param roles_by_pk:
+ :type roles_by_pk: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param type:
+ :type type: List[UserTypeEnum]
+ :param username:
+ :type username: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_export_create_serialize(
+ attributes=attributes,
+ date_joined=date_joined,
+ date_joined__gt=date_joined__gt,
+ date_joined__lt=date_joined__lt,
+ email=email,
+ groups_by_name=groups_by_name,
+ groups_by_pk=groups_by_pk,
+ is_active=is_active,
+ is_superuser=is_superuser,
+ last_login=last_login,
+ last_login__gt=last_login__gt,
+ last_login__isnull=last_login__isnull,
+ last_login__lt=last_login__lt,
+ last_updated=last_updated,
+ last_updated__gt=last_updated__gt,
+ last_updated__lt=last_updated__lt,
+ name=name,
+ ordering=ordering,
+ path=path,
+ path_startswith=path_startswith,
+ roles_by_name=roles_by_name,
+ roles_by_pk=roles_by_pk,
+ search=search,
+ type=type,
+ username=username,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_export_create_without_preload_content(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ date_joined: Optional[datetime] = None,
+ date_joined__gt: Optional[datetime] = None,
+ date_joined__lt: Optional[datetime] = None,
+ email: Optional[StrictStr] = None,
+ groups_by_name: Optional[List[StrictStr]] = None,
+ groups_by_pk: Optional[List[UUID]] = None,
+ is_active: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ last_login: Optional[datetime] = None,
+ last_login__gt: Optional[datetime] = None,
+ last_login__isnull: Optional[StrictBool] = None,
+ last_login__lt: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ last_updated__gt: Optional[datetime] = None,
+ last_updated__lt: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ path: Optional[StrictStr] = None,
+ path_startswith: Optional[StrictStr] = None,
+ roles_by_name: Optional[List[StrictStr]] = None,
+ roles_by_pk: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ type: Optional[List[UserTypeEnum]] = None,
+ username: Optional[StrictStr] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_export_create
+
+ Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param date_joined:
+ :type date_joined: datetime
+ :param date_joined__gt:
+ :type date_joined__gt: datetime
+ :param date_joined__lt:
+ :type date_joined__lt: datetime
+ :param email:
+ :type email: str
+ :param groups_by_name:
+ :type groups_by_name: List[str]
+ :param groups_by_pk:
+ :type groups_by_pk: List[UUID]
+ :param is_active:
+ :type is_active: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param last_login:
+ :type last_login: datetime
+ :param last_login__gt:
+ :type last_login__gt: datetime
+ :param last_login__isnull:
+ :type last_login__isnull: bool
+ :param last_login__lt:
+ :type last_login__lt: datetime
+ :param last_updated:
+ :type last_updated: datetime
+ :param last_updated__gt:
+ :type last_updated__gt: datetime
+ :param last_updated__lt:
+ :type last_updated__lt: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param path:
+ :type path: str
+ :param path_startswith:
+ :type path_startswith: str
+ :param roles_by_name:
+ :type roles_by_name: List[str]
+ :param roles_by_pk:
+ :type roles_by_pk: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param type:
+ :type type: List[UserTypeEnum]
+ :param username:
+ :type username: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_export_create_serialize(
+ attributes=attributes,
+ date_joined=date_joined,
+ date_joined__gt=date_joined__gt,
+ date_joined__lt=date_joined__lt,
+ email=email,
+ groups_by_name=groups_by_name,
+ groups_by_pk=groups_by_pk,
+ is_active=is_active,
+ is_superuser=is_superuser,
+ last_login=last_login,
+ last_login__gt=last_login__gt,
+ last_login__isnull=last_login__isnull,
+ last_login__lt=last_login__lt,
+ last_updated=last_updated,
+ last_updated__gt=last_updated__gt,
+ last_updated__lt=last_updated__lt,
+ name=name,
+ ordering=ordering,
+ path=path,
+ path_startswith=path_startswith,
+ roles_by_name=roles_by_name,
+ roles_by_pk=roles_by_pk,
+ search=search,
+ type=type,
+ username=username,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_export_create_serialize(
+ self,
+ attributes,
+ date_joined,
+ date_joined__gt,
+ date_joined__lt,
+ email,
+ groups_by_name,
+ groups_by_pk,
+ is_active,
+ is_superuser,
+ last_login,
+ last_login__gt,
+ last_login__isnull,
+ last_login__lt,
+ last_updated,
+ last_updated__gt,
+ last_updated__lt,
+ name,
+ ordering,
+ path,
+ path_startswith,
+ roles_by_name,
+ roles_by_pk,
+ search,
+ type,
+ username,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'groups_by_name': 'multi',
+ 'groups_by_pk': 'multi',
+ 'roles_by_name': 'multi',
+ 'roles_by_pk': 'multi',
+ 'type': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if attributes is not None:
+
+ _query_params.append(('attributes', attributes))
+
+ if date_joined is not None:
+ if isinstance(date_joined, datetime):
+ _query_params.append(
+ (
+ 'date_joined',
+ date_joined.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('date_joined', date_joined))
+
+ if date_joined__gt is not None:
+ if isinstance(date_joined__gt, datetime):
+ _query_params.append(
+ (
+ 'date_joined__gt',
+ date_joined__gt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('date_joined__gt', date_joined__gt))
+
+ if date_joined__lt is not None:
+ if isinstance(date_joined__lt, datetime):
+ _query_params.append(
+ (
+ 'date_joined__lt',
+ date_joined__lt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('date_joined__lt', date_joined__lt))
+
+ if email is not None:
+
+ _query_params.append(('email', email))
+
+ if groups_by_name is not None:
+
+ _query_params.append(('groups_by_name', groups_by_name))
+
+ if groups_by_pk is not None:
+
+ _query_params.append(('groups_by_pk', groups_by_pk))
+
+ if is_active is not None:
+
+ _query_params.append(('is_active', is_active))
+
+ if is_superuser is not None:
+
+ _query_params.append(('is_superuser', is_superuser))
+
+ if last_login is not None:
+ if isinstance(last_login, datetime):
+ _query_params.append(
+ (
+ 'last_login',
+ last_login.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_login', last_login))
+
+ if last_login__gt is not None:
+ if isinstance(last_login__gt, datetime):
+ _query_params.append(
+ (
+ 'last_login__gt',
+ last_login__gt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_login__gt', last_login__gt))
+
+ if last_login__isnull is not None:
+
+ _query_params.append(('last_login__isnull', last_login__isnull))
+
+ if last_login__lt is not None:
+ if isinstance(last_login__lt, datetime):
+ _query_params.append(
+ (
+ 'last_login__lt',
+ last_login__lt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_login__lt', last_login__lt))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if last_updated__gt is not None:
+ if isinstance(last_updated__gt, datetime):
+ _query_params.append(
+ (
+ 'last_updated__gt',
+ last_updated__gt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated__gt', last_updated__gt))
+
+ if last_updated__lt is not None:
+ if isinstance(last_updated__lt, datetime):
+ _query_params.append(
+ (
+ 'last_updated__lt',
+ last_updated__lt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated__lt', last_updated__lt))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if path is not None:
+
+ _query_params.append(('path', path))
+
+ if path_startswith is not None:
+
+ _query_params.append(('path_startswith', path_startswith))
+
+ if roles_by_name is not None:
+
+ _query_params.append(('roles_by_name', roles_by_name))
+
+ if roles_by_pk is not None:
+
+ _query_params.append(('roles_by_pk', roles_by_pk))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if type is not None:
+
+ _query_params.append(('type', type))
+
+ if username is not None:
+
+ _query_params.append(('username', username))
+
+ if uuid is not None:
+
+ _query_params.append(('uuid', uuid))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/export/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_impersonate_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ impersonation_request: ImpersonationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_users_impersonate_create
+
+ Impersonate a user
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param impersonation_request: (required)
+ :type impersonation_request: ImpersonationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_impersonate_create_serialize(
+ id=id,
+ impersonation_request=impersonation_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_impersonate_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ impersonation_request: ImpersonationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_users_impersonate_create
+
+ Impersonate a user
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param impersonation_request: (required)
+ :type impersonation_request: ImpersonationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_impersonate_create_serialize(
+ id=id,
+ impersonation_request=impersonation_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_impersonate_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ impersonation_request: ImpersonationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_impersonate_create
+
+ Impersonate a user
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param impersonation_request: (required)
+ :type impersonation_request: ImpersonationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_impersonate_create_serialize(
+ id=id,
+ impersonation_request=impersonation_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_impersonate_create_serialize(
+ self,
+ id,
+ impersonation_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if impersonation_request is not None:
+ _body_params = impersonation_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/{id}/impersonate/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_impersonate_end_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_users_impersonate_end_retrieve
+
+ End Impersonation a user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_impersonate_end_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_impersonate_end_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_users_impersonate_end_retrieve
+
+ End Impersonation a user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_impersonate_end_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_impersonate_end_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_impersonate_end_retrieve
+
+ End Impersonation a user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_impersonate_end_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_impersonate_end_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/users/impersonate_end/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_list(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ date_joined: Optional[datetime] = None,
+ date_joined__gt: Optional[datetime] = None,
+ date_joined__lt: Optional[datetime] = None,
+ email: Optional[StrictStr] = None,
+ groups_by_name: Optional[List[StrictStr]] = None,
+ groups_by_pk: Optional[List[UUID]] = None,
+ include_groups: Optional[StrictBool] = None,
+ include_roles: Optional[StrictBool] = None,
+ is_active: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ last_login: Optional[datetime] = None,
+ last_login__gt: Optional[datetime] = None,
+ last_login__isnull: Optional[StrictBool] = None,
+ last_login__lt: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ last_updated__gt: Optional[datetime] = None,
+ last_updated__lt: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ path: Optional[StrictStr] = None,
+ path_startswith: Optional[StrictStr] = None,
+ roles_by_name: Optional[List[StrictStr]] = None,
+ roles_by_pk: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ type: Optional[List[UserTypeEnum]] = None,
+ username: Optional[StrictStr] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedUserList:
+ """core_users_list
+
+ User Viewset
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param date_joined:
+ :type date_joined: datetime
+ :param date_joined__gt:
+ :type date_joined__gt: datetime
+ :param date_joined__lt:
+ :type date_joined__lt: datetime
+ :param email:
+ :type email: str
+ :param groups_by_name:
+ :type groups_by_name: List[str]
+ :param groups_by_pk:
+ :type groups_by_pk: List[UUID]
+ :param include_groups:
+ :type include_groups: bool
+ :param include_roles:
+ :type include_roles: bool
+ :param is_active:
+ :type is_active: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param last_login:
+ :type last_login: datetime
+ :param last_login__gt:
+ :type last_login__gt: datetime
+ :param last_login__isnull:
+ :type last_login__isnull: bool
+ :param last_login__lt:
+ :type last_login__lt: datetime
+ :param last_updated:
+ :type last_updated: datetime
+ :param last_updated__gt:
+ :type last_updated__gt: datetime
+ :param last_updated__lt:
+ :type last_updated__lt: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param path:
+ :type path: str
+ :param path_startswith:
+ :type path_startswith: str
+ :param roles_by_name:
+ :type roles_by_name: List[str]
+ :param roles_by_pk:
+ :type roles_by_pk: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param type:
+ :type type: List[UserTypeEnum]
+ :param username:
+ :type username: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_list_serialize(
+ attributes=attributes,
+ date_joined=date_joined,
+ date_joined__gt=date_joined__gt,
+ date_joined__lt=date_joined__lt,
+ email=email,
+ groups_by_name=groups_by_name,
+ groups_by_pk=groups_by_pk,
+ include_groups=include_groups,
+ include_roles=include_roles,
+ is_active=is_active,
+ is_superuser=is_superuser,
+ last_login=last_login,
+ last_login__gt=last_login__gt,
+ last_login__isnull=last_login__isnull,
+ last_login__lt=last_login__lt,
+ last_updated=last_updated,
+ last_updated__gt=last_updated__gt,
+ last_updated__lt=last_updated__lt,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ path=path,
+ path_startswith=path_startswith,
+ roles_by_name=roles_by_name,
+ roles_by_pk=roles_by_pk,
+ search=search,
+ type=type,
+ username=username,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_list_with_http_info(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ date_joined: Optional[datetime] = None,
+ date_joined__gt: Optional[datetime] = None,
+ date_joined__lt: Optional[datetime] = None,
+ email: Optional[StrictStr] = None,
+ groups_by_name: Optional[List[StrictStr]] = None,
+ groups_by_pk: Optional[List[UUID]] = None,
+ include_groups: Optional[StrictBool] = None,
+ include_roles: Optional[StrictBool] = None,
+ is_active: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ last_login: Optional[datetime] = None,
+ last_login__gt: Optional[datetime] = None,
+ last_login__isnull: Optional[StrictBool] = None,
+ last_login__lt: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ last_updated__gt: Optional[datetime] = None,
+ last_updated__lt: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ path: Optional[StrictStr] = None,
+ path_startswith: Optional[StrictStr] = None,
+ roles_by_name: Optional[List[StrictStr]] = None,
+ roles_by_pk: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ type: Optional[List[UserTypeEnum]] = None,
+ username: Optional[StrictStr] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedUserList]:
+ """core_users_list
+
+ User Viewset
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param date_joined:
+ :type date_joined: datetime
+ :param date_joined__gt:
+ :type date_joined__gt: datetime
+ :param date_joined__lt:
+ :type date_joined__lt: datetime
+ :param email:
+ :type email: str
+ :param groups_by_name:
+ :type groups_by_name: List[str]
+ :param groups_by_pk:
+ :type groups_by_pk: List[UUID]
+ :param include_groups:
+ :type include_groups: bool
+ :param include_roles:
+ :type include_roles: bool
+ :param is_active:
+ :type is_active: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param last_login:
+ :type last_login: datetime
+ :param last_login__gt:
+ :type last_login__gt: datetime
+ :param last_login__isnull:
+ :type last_login__isnull: bool
+ :param last_login__lt:
+ :type last_login__lt: datetime
+ :param last_updated:
+ :type last_updated: datetime
+ :param last_updated__gt:
+ :type last_updated__gt: datetime
+ :param last_updated__lt:
+ :type last_updated__lt: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param path:
+ :type path: str
+ :param path_startswith:
+ :type path_startswith: str
+ :param roles_by_name:
+ :type roles_by_name: List[str]
+ :param roles_by_pk:
+ :type roles_by_pk: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param type:
+ :type type: List[UserTypeEnum]
+ :param username:
+ :type username: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_list_serialize(
+ attributes=attributes,
+ date_joined=date_joined,
+ date_joined__gt=date_joined__gt,
+ date_joined__lt=date_joined__lt,
+ email=email,
+ groups_by_name=groups_by_name,
+ groups_by_pk=groups_by_pk,
+ include_groups=include_groups,
+ include_roles=include_roles,
+ is_active=is_active,
+ is_superuser=is_superuser,
+ last_login=last_login,
+ last_login__gt=last_login__gt,
+ last_login__isnull=last_login__isnull,
+ last_login__lt=last_login__lt,
+ last_updated=last_updated,
+ last_updated__gt=last_updated__gt,
+ last_updated__lt=last_updated__lt,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ path=path,
+ path_startswith=path_startswith,
+ roles_by_name=roles_by_name,
+ roles_by_pk=roles_by_pk,
+ search=search,
+ type=type,
+ username=username,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_list_without_preload_content(
+ self,
+ attributes: Annotated[Optional[StrictStr], Field(description="Attributes")] = None,
+ date_joined: Optional[datetime] = None,
+ date_joined__gt: Optional[datetime] = None,
+ date_joined__lt: Optional[datetime] = None,
+ email: Optional[StrictStr] = None,
+ groups_by_name: Optional[List[StrictStr]] = None,
+ groups_by_pk: Optional[List[UUID]] = None,
+ include_groups: Optional[StrictBool] = None,
+ include_roles: Optional[StrictBool] = None,
+ is_active: Optional[StrictBool] = None,
+ is_superuser: Optional[StrictBool] = None,
+ last_login: Optional[datetime] = None,
+ last_login__gt: Optional[datetime] = None,
+ last_login__isnull: Optional[StrictBool] = None,
+ last_login__lt: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ last_updated__gt: Optional[datetime] = None,
+ last_updated__lt: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ path: Optional[StrictStr] = None,
+ path_startswith: Optional[StrictStr] = None,
+ roles_by_name: Optional[List[StrictStr]] = None,
+ roles_by_pk: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ type: Optional[List[UserTypeEnum]] = None,
+ username: Optional[StrictStr] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_list
+
+ User Viewset
+
+ :param attributes: Attributes
+ :type attributes: str
+ :param date_joined:
+ :type date_joined: datetime
+ :param date_joined__gt:
+ :type date_joined__gt: datetime
+ :param date_joined__lt:
+ :type date_joined__lt: datetime
+ :param email:
+ :type email: str
+ :param groups_by_name:
+ :type groups_by_name: List[str]
+ :param groups_by_pk:
+ :type groups_by_pk: List[UUID]
+ :param include_groups:
+ :type include_groups: bool
+ :param include_roles:
+ :type include_roles: bool
+ :param is_active:
+ :type is_active: bool
+ :param is_superuser:
+ :type is_superuser: bool
+ :param last_login:
+ :type last_login: datetime
+ :param last_login__gt:
+ :type last_login__gt: datetime
+ :param last_login__isnull:
+ :type last_login__isnull: bool
+ :param last_login__lt:
+ :type last_login__lt: datetime
+ :param last_updated:
+ :type last_updated: datetime
+ :param last_updated__gt:
+ :type last_updated__gt: datetime
+ :param last_updated__lt:
+ :type last_updated__lt: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param path:
+ :type path: str
+ :param path_startswith:
+ :type path_startswith: str
+ :param roles_by_name:
+ :type roles_by_name: List[str]
+ :param roles_by_pk:
+ :type roles_by_pk: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param type:
+ :type type: List[UserTypeEnum]
+ :param username:
+ :type username: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_list_serialize(
+ attributes=attributes,
+ date_joined=date_joined,
+ date_joined__gt=date_joined__gt,
+ date_joined__lt=date_joined__lt,
+ email=email,
+ groups_by_name=groups_by_name,
+ groups_by_pk=groups_by_pk,
+ include_groups=include_groups,
+ include_roles=include_roles,
+ is_active=is_active,
+ is_superuser=is_superuser,
+ last_login=last_login,
+ last_login__gt=last_login__gt,
+ last_login__isnull=last_login__isnull,
+ last_login__lt=last_login__lt,
+ last_updated=last_updated,
+ last_updated__gt=last_updated__gt,
+ last_updated__lt=last_updated__lt,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ path=path,
+ path_startswith=path_startswith,
+ roles_by_name=roles_by_name,
+ roles_by_pk=roles_by_pk,
+ search=search,
+ type=type,
+ username=username,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_list_serialize(
+ self,
+ attributes,
+ date_joined,
+ date_joined__gt,
+ date_joined__lt,
+ email,
+ groups_by_name,
+ groups_by_pk,
+ include_groups,
+ include_roles,
+ is_active,
+ is_superuser,
+ last_login,
+ last_login__gt,
+ last_login__isnull,
+ last_login__lt,
+ last_updated,
+ last_updated__gt,
+ last_updated__lt,
+ name,
+ ordering,
+ page,
+ page_size,
+ path,
+ path_startswith,
+ roles_by_name,
+ roles_by_pk,
+ search,
+ type,
+ username,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'groups_by_name': 'multi',
+ 'groups_by_pk': 'multi',
+ 'roles_by_name': 'multi',
+ 'roles_by_pk': 'multi',
+ 'type': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if attributes is not None:
+
+ _query_params.append(('attributes', attributes))
+
+ if date_joined is not None:
+ if isinstance(date_joined, datetime):
+ _query_params.append(
+ (
+ 'date_joined',
+ date_joined.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('date_joined', date_joined))
+
+ if date_joined__gt is not None:
+ if isinstance(date_joined__gt, datetime):
+ _query_params.append(
+ (
+ 'date_joined__gt',
+ date_joined__gt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('date_joined__gt', date_joined__gt))
+
+ if date_joined__lt is not None:
+ if isinstance(date_joined__lt, datetime):
+ _query_params.append(
+ (
+ 'date_joined__lt',
+ date_joined__lt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('date_joined__lt', date_joined__lt))
+
+ if email is not None:
+
+ _query_params.append(('email', email))
+
+ if groups_by_name is not None:
+
+ _query_params.append(('groups_by_name', groups_by_name))
+
+ if groups_by_pk is not None:
+
+ _query_params.append(('groups_by_pk', groups_by_pk))
+
+ if include_groups is not None:
+
+ _query_params.append(('include_groups', include_groups))
+
+ if include_roles is not None:
+
+ _query_params.append(('include_roles', include_roles))
+
+ if is_active is not None:
+
+ _query_params.append(('is_active', is_active))
+
+ if is_superuser is not None:
+
+ _query_params.append(('is_superuser', is_superuser))
+
+ if last_login is not None:
+ if isinstance(last_login, datetime):
+ _query_params.append(
+ (
+ 'last_login',
+ last_login.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_login', last_login))
+
+ if last_login__gt is not None:
+ if isinstance(last_login__gt, datetime):
+ _query_params.append(
+ (
+ 'last_login__gt',
+ last_login__gt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_login__gt', last_login__gt))
+
+ if last_login__isnull is not None:
+
+ _query_params.append(('last_login__isnull', last_login__isnull))
+
+ if last_login__lt is not None:
+ if isinstance(last_login__lt, datetime):
+ _query_params.append(
+ (
+ 'last_login__lt',
+ last_login__lt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_login__lt', last_login__lt))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if last_updated__gt is not None:
+ if isinstance(last_updated__gt, datetime):
+ _query_params.append(
+ (
+ 'last_updated__gt',
+ last_updated__gt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated__gt', last_updated__gt))
+
+ if last_updated__lt is not None:
+ if isinstance(last_updated__lt, datetime):
+ _query_params.append(
+ (
+ 'last_updated__lt',
+ last_updated__lt.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated__lt', last_updated__lt))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if path is not None:
+
+ _query_params.append(('path', path))
+
+ if path_startswith is not None:
+
+ _query_params.append(('path_startswith', path_startswith))
+
+ if roles_by_name is not None:
+
+ _query_params.append(('roles_by_name', roles_by_name))
+
+ if roles_by_pk is not None:
+
+ _query_params.append(('roles_by_pk', roles_by_pk))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if type is not None:
+
+ _query_params.append(('type', type))
+
+ if username is not None:
+
+ _query_params.append(('username', username))
+
+ if uuid is not None:
+
+ _query_params.append(('uuid', uuid))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_me_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SessionUser:
+ """core_users_me_retrieve
+
+ Get information about current user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_me_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SessionUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_me_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SessionUser]:
+ """core_users_me_retrieve
+
+ Get information about current user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_me_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SessionUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_me_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_me_retrieve
+
+ Get information about current user
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_me_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SessionUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_me_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/users/me/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ patched_user_request: Optional[PatchedUserRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> User:
+ """core_users_partial_update
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param patched_user_request:
+ :type patched_user_request: PatchedUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_partial_update_serialize(
+ id=id,
+ patched_user_request=patched_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ patched_user_request: Optional[PatchedUserRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[User]:
+ """core_users_partial_update
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param patched_user_request:
+ :type patched_user_request: PatchedUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_partial_update_serialize(
+ id=id,
+ patched_user_request=patched_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ patched_user_request: Optional[PatchedUserRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_partial_update
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param patched_user_request:
+ :type patched_user_request: PatchedUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_partial_update_serialize(
+ id=id,
+ patched_user_request=patched_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_partial_update_serialize(
+ self,
+ id,
+ patched_user_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_user_request is not None:
+ _body_params = patched_user_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/core/users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_paths_retrieve(
+ self,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UserPath:
+ """core_users_paths_retrieve
+
+ Get all user paths
+
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_paths_retrieve_serialize(
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserPath",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_paths_retrieve_with_http_info(
+ self,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UserPath]:
+ """core_users_paths_retrieve
+
+ Get all user paths
+
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_paths_retrieve_serialize(
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserPath",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_paths_retrieve_without_preload_content(
+ self,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_paths_retrieve
+
+ Get all user paths
+
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_paths_retrieve_serialize(
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserPath",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_paths_retrieve_serialize(
+ self,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/users/paths/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_recovery_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_recovery_link_request: Optional[UserRecoveryLinkRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Link:
+ """core_users_recovery_create
+
+ Create a temporary link that a user can use to recover their account
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_recovery_link_request:
+ :type user_recovery_link_request: UserRecoveryLinkRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_recovery_create_serialize(
+ id=id,
+ user_recovery_link_request=user_recovery_link_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_recovery_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_recovery_link_request: Optional[UserRecoveryLinkRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Link]:
+ """core_users_recovery_create
+
+ Create a temporary link that a user can use to recover their account
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_recovery_link_request:
+ :type user_recovery_link_request: UserRecoveryLinkRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_recovery_create_serialize(
+ id=id,
+ user_recovery_link_request=user_recovery_link_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_recovery_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_recovery_link_request: Optional[UserRecoveryLinkRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_recovery_create
+
+ Create a temporary link that a user can use to recover their account
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_recovery_link_request:
+ :type user_recovery_link_request: UserRecoveryLinkRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_recovery_create_serialize(
+ id=id,
+ user_recovery_link_request=user_recovery_link_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_recovery_create_serialize(
+ self,
+ id,
+ user_recovery_link_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_recovery_link_request is not None:
+ _body_params = user_recovery_link_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/{id}/recovery/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_recovery_email_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_recovery_email_request: UserRecoveryEmailRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_users_recovery_email_create
+
+ Send an email with a temporary link that a user can use to recover their account
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_recovery_email_request: (required)
+ :type user_recovery_email_request: UserRecoveryEmailRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_recovery_email_create_serialize(
+ id=id,
+ user_recovery_email_request=user_recovery_email_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_recovery_email_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_recovery_email_request: UserRecoveryEmailRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_users_recovery_email_create
+
+ Send an email with a temporary link that a user can use to recover their account
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_recovery_email_request: (required)
+ :type user_recovery_email_request: UserRecoveryEmailRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_recovery_email_create_serialize(
+ id=id,
+ user_recovery_email_request=user_recovery_email_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_recovery_email_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_recovery_email_request: UserRecoveryEmailRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_recovery_email_create
+
+ Send an email with a temporary link that a user can use to recover their account
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_recovery_email_request: (required)
+ :type user_recovery_email_request: UserRecoveryEmailRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_recovery_email_create_serialize(
+ id=id,
+ user_recovery_email_request=user_recovery_email_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_recovery_email_create_serialize(
+ self,
+ id,
+ user_recovery_email_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_recovery_email_request is not None:
+ _body_params = user_recovery_email_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/{id}/recovery_email/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> User:
+ """core_users_retrieve
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[User]:
+ """core_users_retrieve
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_retrieve
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_service_account_create(
+ self,
+ user_service_account_request: UserServiceAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UserServiceAccountResponse:
+ """core_users_service_account_create
+
+ Create a new user account that is marked as a service account
+
+ :param user_service_account_request: (required)
+ :type user_service_account_request: UserServiceAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_service_account_create_serialize(
+ user_service_account_request=user_service_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserServiceAccountResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_service_account_create_with_http_info(
+ self,
+ user_service_account_request: UserServiceAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UserServiceAccountResponse]:
+ """core_users_service_account_create
+
+ Create a new user account that is marked as a service account
+
+ :param user_service_account_request: (required)
+ :type user_service_account_request: UserServiceAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_service_account_create_serialize(
+ user_service_account_request=user_service_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserServiceAccountResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_service_account_create_without_preload_content(
+ self,
+ user_service_account_request: UserServiceAccountRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_service_account_create
+
+ Create a new user account that is marked as a service account
+
+ :param user_service_account_request: (required)
+ :type user_service_account_request: UserServiceAccountRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_service_account_create_serialize(
+ user_service_account_request=user_service_account_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserServiceAccountResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_service_account_create_serialize(
+ self,
+ user_service_account_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_service_account_request is not None:
+ _body_params = user_service_account_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/service_account/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_set_password_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_password_set_request: UserPasswordSetRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_users_set_password_create
+
+ Set password for user
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_password_set_request: (required)
+ :type user_password_set_request: UserPasswordSetRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_set_password_create_serialize(
+ id=id,
+ user_password_set_request=user_password_set_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_set_password_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_password_set_request: UserPasswordSetRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_users_set_password_create
+
+ Set password for user
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_password_set_request: (required)
+ :type user_password_set_request: UserPasswordSetRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_set_password_create_serialize(
+ id=id,
+ user_password_set_request=user_password_set_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_set_password_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_password_set_request: UserPasswordSetRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_set_password_create
+
+ Set password for user
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_password_set_request: (required)
+ :type user_password_set_request: UserPasswordSetRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_set_password_create_serialize(
+ id=id,
+ user_password_set_request=user_password_set_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_set_password_create_serialize(
+ self,
+ id,
+ user_password_set_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_password_set_request is not None:
+ _body_params = user_password_set_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/{id}/set_password/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_set_password_hash_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_password_hash_set_request: UserPasswordHashSetRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """core_users_set_password_hash_create
+
+ Set a user's password from a pre-hashed Django password value. Submit the Django password hash in the shared ``password`` request field. This updates authentik's local password verifier only. It does not attempt to propagate the password change to LDAP or Kerberos because no raw password is available from the request payload.
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_password_hash_set_request: (required)
+ :type user_password_hash_set_request: UserPasswordHashSetRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_set_password_hash_create_serialize(
+ id=id,
+ user_password_hash_set_request=user_password_hash_set_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_set_password_hash_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_password_hash_set_request: UserPasswordHashSetRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """core_users_set_password_hash_create
+
+ Set a user's password from a pre-hashed Django password value. Submit the Django password hash in the shared ``password`` request field. This updates authentik's local password verifier only. It does not attempt to propagate the password change to LDAP or Kerberos because no raw password is available from the request payload.
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_password_hash_set_request: (required)
+ :type user_password_hash_set_request: UserPasswordHashSetRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_set_password_hash_create_serialize(
+ id=id,
+ user_password_hash_set_request=user_password_hash_set_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_set_password_hash_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_password_hash_set_request: UserPasswordHashSetRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_set_password_hash_create
+
+ Set a user's password from a pre-hashed Django password value. Submit the Django password hash in the shared ``password`` request field. This updates authentik's local password verifier only. It does not attempt to propagate the password change to LDAP or Kerberos because no raw password is available from the request payload.
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_password_hash_set_request: (required)
+ :type user_password_hash_set_request: UserPasswordHashSetRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_set_password_hash_create_serialize(
+ id=id,
+ user_password_hash_set_request=user_password_hash_set_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_set_password_hash_create_serialize(
+ self,
+ id,
+ user_password_hash_set_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_password_hash_set_request is not None:
+ _body_params = user_password_hash_set_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/core/users/{id}/set_password_hash/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_request: UserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> User:
+ """core_users_update
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_request: (required)
+ :type user_request: UserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_update_serialize(
+ id=id,
+ user_request=user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_request: UserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[User]:
+ """core_users_update
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_request: (required)
+ :type user_request: UserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_update_serialize(
+ id=id,
+ user_request=user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ user_request: UserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_update
+
+ User Viewset
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param user_request: (required)
+ :type user_request: UserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_update_serialize(
+ id=id,
+ user_request=user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "User",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_update_serialize(
+ self,
+ id,
+ user_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_request is not None:
+ _body_params = user_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/core/users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def core_users_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """core_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def core_users_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """core_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def core_users_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """core_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this User. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._core_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _core_users_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/core/users/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/crypto_api.py b/authentik_client/api/crypto_api.py
new file mode 100644
index 000000000..e7494d417
--- /dev/null
+++ b/authentik_client/api/crypto_api.py
@@ -0,0 +1,2955 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.certificate_data import CertificateData
+from authentik_client.models.certificate_generation_request import CertificateGenerationRequest
+from authentik_client.models.certificate_key_pair import CertificateKeyPair
+from authentik_client.models.certificate_key_pair_request import CertificateKeyPairRequest
+from authentik_client.models.key_type_enum import KeyTypeEnum
+from authentik_client.models.paginated_certificate_key_pair_list import PaginatedCertificateKeyPairList
+from authentik_client.models.patched_certificate_key_pair_request import PatchedCertificateKeyPairRequest
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class CryptoApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def crypto_certificatekeypairs_create(
+ self,
+ certificate_key_pair_request: CertificateKeyPairRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateKeyPair:
+ """crypto_certificatekeypairs_create
+
+ CertificateKeyPair Viewset
+
+ :param certificate_key_pair_request: (required)
+ :type certificate_key_pair_request: CertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_create_serialize(
+ certificate_key_pair_request=certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_create_with_http_info(
+ self,
+ certificate_key_pair_request: CertificateKeyPairRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateKeyPair]:
+ """crypto_certificatekeypairs_create
+
+ CertificateKeyPair Viewset
+
+ :param certificate_key_pair_request: (required)
+ :type certificate_key_pair_request: CertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_create_serialize(
+ certificate_key_pair_request=certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_create_without_preload_content(
+ self,
+ certificate_key_pair_request: CertificateKeyPairRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_create
+
+ CertificateKeyPair Viewset
+
+ :param certificate_key_pair_request: (required)
+ :type certificate_key_pair_request: CertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_create_serialize(
+ certificate_key_pair_request=certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_create_serialize(
+ self,
+ certificate_key_pair_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if certificate_key_pair_request is not None:
+ _body_params = certificate_key_pair_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/crypto/certificatekeypairs/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_destroy(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """crypto_certificatekeypairs_destroy
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_destroy_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_destroy_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """crypto_certificatekeypairs_destroy
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_destroy_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_destroy_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_destroy
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_destroy_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_destroy_serialize(
+ self,
+ kp_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_generate_create(
+ self,
+ certificate_generation_request: CertificateGenerationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateKeyPair:
+ """crypto_certificatekeypairs_generate_create
+
+ Generate a new, self-signed certificate-key pair
+
+ :param certificate_generation_request: (required)
+ :type certificate_generation_request: CertificateGenerationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_generate_create_serialize(
+ certificate_generation_request=certificate_generation_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_generate_create_with_http_info(
+ self,
+ certificate_generation_request: CertificateGenerationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateKeyPair]:
+ """crypto_certificatekeypairs_generate_create
+
+ Generate a new, self-signed certificate-key pair
+
+ :param certificate_generation_request: (required)
+ :type certificate_generation_request: CertificateGenerationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_generate_create_serialize(
+ certificate_generation_request=certificate_generation_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_generate_create_without_preload_content(
+ self,
+ certificate_generation_request: CertificateGenerationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_generate_create
+
+ Generate a new, self-signed certificate-key pair
+
+ :param certificate_generation_request: (required)
+ :type certificate_generation_request: CertificateGenerationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_generate_create_serialize(
+ certificate_generation_request=certificate_generation_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_generate_create_serialize(
+ self,
+ certificate_generation_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if certificate_generation_request is not None:
+ _body_params = certificate_generation_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/crypto/certificatekeypairs/generate/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_list(
+ self,
+ has_key: Annotated[Optional[StrictBool], Field(description="Only return certificate-key pairs with keys")] = None,
+ key_type: Optional[List[KeyTypeEnum]] = None,
+ managed: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedCertificateKeyPairList:
+ """crypto_certificatekeypairs_list
+
+ CertificateKeyPair Viewset
+
+ :param has_key: Only return certificate-key pairs with keys
+ :type has_key: bool
+ :param key_type:
+ :type key_type: List[KeyTypeEnum]
+ :param managed:
+ :type managed: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_list_serialize(
+ has_key=has_key,
+ key_type=key_type,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedCertificateKeyPairList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_list_with_http_info(
+ self,
+ has_key: Annotated[Optional[StrictBool], Field(description="Only return certificate-key pairs with keys")] = None,
+ key_type: Optional[List[KeyTypeEnum]] = None,
+ managed: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedCertificateKeyPairList]:
+ """crypto_certificatekeypairs_list
+
+ CertificateKeyPair Viewset
+
+ :param has_key: Only return certificate-key pairs with keys
+ :type has_key: bool
+ :param key_type:
+ :type key_type: List[KeyTypeEnum]
+ :param managed:
+ :type managed: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_list_serialize(
+ has_key=has_key,
+ key_type=key_type,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedCertificateKeyPairList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_list_without_preload_content(
+ self,
+ has_key: Annotated[Optional[StrictBool], Field(description="Only return certificate-key pairs with keys")] = None,
+ key_type: Optional[List[KeyTypeEnum]] = None,
+ managed: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_list
+
+ CertificateKeyPair Viewset
+
+ :param has_key: Only return certificate-key pairs with keys
+ :type has_key: bool
+ :param key_type:
+ :type key_type: List[KeyTypeEnum]
+ :param managed:
+ :type managed: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_list_serialize(
+ has_key=has_key,
+ key_type=key_type,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedCertificateKeyPairList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_list_serialize(
+ self,
+ has_key,
+ key_type,
+ managed,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'key_type': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if has_key is not None:
+
+ _query_params.append(('has_key', has_key))
+
+ if key_type is not None:
+
+ _query_params.append(('key_type', key_type))
+
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/crypto/certificatekeypairs/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_partial_update(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ patched_certificate_key_pair_request: Optional[PatchedCertificateKeyPairRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateKeyPair:
+ """crypto_certificatekeypairs_partial_update
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param patched_certificate_key_pair_request:
+ :type patched_certificate_key_pair_request: PatchedCertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_partial_update_serialize(
+ kp_uuid=kp_uuid,
+ patched_certificate_key_pair_request=patched_certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_partial_update_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ patched_certificate_key_pair_request: Optional[PatchedCertificateKeyPairRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateKeyPair]:
+ """crypto_certificatekeypairs_partial_update
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param patched_certificate_key_pair_request:
+ :type patched_certificate_key_pair_request: PatchedCertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_partial_update_serialize(
+ kp_uuid=kp_uuid,
+ patched_certificate_key_pair_request=patched_certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_partial_update_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ patched_certificate_key_pair_request: Optional[PatchedCertificateKeyPairRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_partial_update
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param patched_certificate_key_pair_request:
+ :type patched_certificate_key_pair_request: PatchedCertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_partial_update_serialize(
+ kp_uuid=kp_uuid,
+ patched_certificate_key_pair_request=patched_certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_partial_update_serialize(
+ self,
+ kp_uuid,
+ patched_certificate_key_pair_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_certificate_key_pair_request is not None:
+ _body_params = patched_certificate_key_pair_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_retrieve(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateKeyPair:
+ """crypto_certificatekeypairs_retrieve
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_retrieve_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateKeyPair]:
+ """crypto_certificatekeypairs_retrieve
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_retrieve_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_retrieve
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_retrieve_serialize(
+ self,
+ kp_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_update(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ certificate_key_pair_request: CertificateKeyPairRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateKeyPair:
+ """crypto_certificatekeypairs_update
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param certificate_key_pair_request: (required)
+ :type certificate_key_pair_request: CertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_update_serialize(
+ kp_uuid=kp_uuid,
+ certificate_key_pair_request=certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_update_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ certificate_key_pair_request: CertificateKeyPairRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateKeyPair]:
+ """crypto_certificatekeypairs_update
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param certificate_key_pair_request: (required)
+ :type certificate_key_pair_request: CertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_update_serialize(
+ kp_uuid=kp_uuid,
+ certificate_key_pair_request=certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_update_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ certificate_key_pair_request: CertificateKeyPairRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_update
+
+ CertificateKeyPair Viewset
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param certificate_key_pair_request: (required)
+ :type certificate_key_pair_request: CertificateKeyPairRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_update_serialize(
+ kp_uuid=kp_uuid,
+ certificate_key_pair_request=certificate_key_pair_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateKeyPair",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_update_serialize(
+ self,
+ kp_uuid,
+ certificate_key_pair_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if certificate_key_pair_request is not None:
+ _body_params = certificate_key_pair_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_used_by_list(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """crypto_certificatekeypairs_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_used_by_list_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_used_by_list_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """crypto_certificatekeypairs_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_used_by_list_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_used_by_list_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_used_by_list_serialize(
+ kp_uuid=kp_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_used_by_list_serialize(
+ self,
+ kp_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_view_certificate_retrieve(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ download: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateData:
+ """crypto_certificatekeypairs_view_certificate_retrieve
+
+ Return certificate-key pairs certificate and log access
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param download:
+ :type download: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_view_certificate_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ download=download,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateData",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_view_certificate_retrieve_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ download: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateData]:
+ """crypto_certificatekeypairs_view_certificate_retrieve
+
+ Return certificate-key pairs certificate and log access
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param download:
+ :type download: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_view_certificate_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ download=download,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateData",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_view_certificate_retrieve_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ download: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_view_certificate_retrieve
+
+ Return certificate-key pairs certificate and log access
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param download:
+ :type download: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_view_certificate_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ download=download,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateData",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_view_certificate_retrieve_serialize(
+ self,
+ kp_uuid,
+ download,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ if download is not None:
+
+ _query_params.append(('download', download))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/view_certificate/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def crypto_certificatekeypairs_view_private_key_retrieve(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ download: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> CertificateData:
+ """crypto_certificatekeypairs_view_private_key_retrieve
+
+ Return certificate-key pairs private key and log access
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param download:
+ :type download: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_view_private_key_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ download=download,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateData",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def crypto_certificatekeypairs_view_private_key_retrieve_with_http_info(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ download: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[CertificateData]:
+ """crypto_certificatekeypairs_view_private_key_retrieve
+
+ Return certificate-key pairs private key and log access
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param download:
+ :type download: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_view_private_key_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ download=download,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateData",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def crypto_certificatekeypairs_view_private_key_retrieve_without_preload_content(
+ self,
+ kp_uuid: Annotated[UUID, Field(description="A UUID string identifying this Certificate-Key Pair.")],
+ download: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """crypto_certificatekeypairs_view_private_key_retrieve
+
+ Return certificate-key pairs private key and log access
+
+ :param kp_uuid: A UUID string identifying this Certificate-Key Pair. (required)
+ :type kp_uuid: UUID
+ :param download:
+ :type download: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._crypto_certificatekeypairs_view_private_key_retrieve_serialize(
+ kp_uuid=kp_uuid,
+ download=download,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "CertificateData",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _crypto_certificatekeypairs_view_private_key_retrieve_serialize(
+ self,
+ kp_uuid,
+ download,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if kp_uuid is not None:
+ _path_params['kp_uuid'] = kp_uuid
+ # process the query parameters
+ if download is not None:
+
+ _query_params.append(('download', download))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/crypto/certificatekeypairs/{kp_uuid}/view_private_key/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/endpoints_api.py b/authentik_client/api/endpoints_api.py
new file mode 100644
index 000000000..7a2ad9b8d
--- /dev/null
+++ b/authentik_client/api/endpoints_api.py
@@ -0,0 +1,20134 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.agent_authentication_response import AgentAuthenticationResponse
+from authentik_client.models.agent_config import AgentConfig
+from authentik_client.models.agent_connector import AgentConnector
+from authentik_client.models.agent_connector_request import AgentConnectorRequest
+from authentik_client.models.agent_psso_device_registration_request import AgentPSSODeviceRegistrationRequest
+from authentik_client.models.agent_psso_device_registration_response import AgentPSSODeviceRegistrationResponse
+from authentik_client.models.agent_psso_user_registration_request import AgentPSSOUserRegistrationRequest
+from authentik_client.models.agent_token_response import AgentTokenResponse
+from authentik_client.models.apple_independent_secure_enclave import AppleIndependentSecureEnclave
+from authentik_client.models.apple_independent_secure_enclave_request import AppleIndependentSecureEnclaveRequest
+from authentik_client.models.connector import Connector
+from authentik_client.models.device_access_group import DeviceAccessGroup
+from authentik_client.models.device_access_group_request import DeviceAccessGroupRequest
+from authentik_client.models.device_facts_request import DeviceFactsRequest
+from authentik_client.models.device_summary import DeviceSummary
+from authentik_client.models.device_user_binding import DeviceUserBinding
+from authentik_client.models.device_user_binding_request import DeviceUserBindingRequest
+from authentik_client.models.endpoint_device import EndpointDevice
+from authentik_client.models.endpoint_device_details import EndpointDeviceDetails
+from authentik_client.models.endpoint_device_request import EndpointDeviceRequest
+from authentik_client.models.enroll_request import EnrollRequest
+from authentik_client.models.enrollment_token import EnrollmentToken
+from authentik_client.models.enrollment_token_request import EnrollmentTokenRequest
+from authentik_client.models.fleet_connector import FleetConnector
+from authentik_client.models.fleet_connector_request import FleetConnectorRequest
+from authentik_client.models.google_chrome_connector import GoogleChromeConnector
+from authentik_client.models.google_chrome_connector_request import GoogleChromeConnectorRequest
+from authentik_client.models.mdm_config_request import MDMConfigRequest
+from authentik_client.models.mdm_config_response import MDMConfigResponse
+from authentik_client.models.paginated_agent_connector_list import PaginatedAgentConnectorList
+from authentik_client.models.paginated_apple_independent_secure_enclave_list import PaginatedAppleIndependentSecureEnclaveList
+from authentik_client.models.paginated_connector_list import PaginatedConnectorList
+from authentik_client.models.paginated_device_access_group_list import PaginatedDeviceAccessGroupList
+from authentik_client.models.paginated_device_user_binding_list import PaginatedDeviceUserBindingList
+from authentik_client.models.paginated_endpoint_device_list import PaginatedEndpointDeviceList
+from authentik_client.models.paginated_enrollment_token_list import PaginatedEnrollmentTokenList
+from authentik_client.models.paginated_fleet_connector_list import PaginatedFleetConnectorList
+from authentik_client.models.paginated_google_chrome_connector_list import PaginatedGoogleChromeConnectorList
+from authentik_client.models.patched_agent_connector_request import PatchedAgentConnectorRequest
+from authentik_client.models.patched_apple_independent_secure_enclave_request import PatchedAppleIndependentSecureEnclaveRequest
+from authentik_client.models.patched_device_access_group_request import PatchedDeviceAccessGroupRequest
+from authentik_client.models.patched_device_user_binding_request import PatchedDeviceUserBindingRequest
+from authentik_client.models.patched_endpoint_device_request import PatchedEndpointDeviceRequest
+from authentik_client.models.patched_enrollment_token_request import PatchedEnrollmentTokenRequest
+from authentik_client.models.patched_fleet_connector_request import PatchedFleetConnectorRequest
+from authentik_client.models.patched_google_chrome_connector_request import PatchedGoogleChromeConnectorRequest
+from authentik_client.models.token_view import TokenView
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.user_self import UserSelf
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class EndpointsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def endpoints_agents_connectors_agent_config_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentConfig:
+ """endpoints_agents_connectors_agent_config_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_agent_config_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConfig",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_agent_config_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentConfig]:
+ """endpoints_agents_connectors_agent_config_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_agent_config_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConfig",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_agent_config_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_agent_config_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_agent_config_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConfig",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_agent_config_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/connectors/agent_config/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_auth_fed_create(
+ self,
+ device: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentTokenResponse:
+ """endpoints_agents_connectors_auth_fed_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device: (required)
+ :type device: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_auth_fed_create_serialize(
+ device=device,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentTokenResponse",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_auth_fed_create_with_http_info(
+ self,
+ device: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentTokenResponse]:
+ """endpoints_agents_connectors_auth_fed_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device: (required)
+ :type device: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_auth_fed_create_serialize(
+ device=device,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentTokenResponse",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_auth_fed_create_without_preload_content(
+ self,
+ device: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_auth_fed_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device: (required)
+ :type device: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_auth_fed_create_serialize(
+ device=device,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentTokenResponse",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_auth_fed_create_serialize(
+ self,
+ device,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if device is not None:
+
+ _query_params.append(('device', device))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/connectors/auth_fed/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_auth_ia_create(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentAuthenticationResponse:
+ """endpoints_agents_connectors_auth_ia_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_auth_ia_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentAuthenticationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_auth_ia_create_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentAuthenticationResponse]:
+ """endpoints_agents_connectors_auth_ia_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_auth_ia_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentAuthenticationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_auth_ia_create_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_auth_ia_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_auth_ia_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentAuthenticationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_auth_ia_create_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/connectors/auth_ia/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_check_in_create(
+ self,
+ device_facts_request: Optional[DeviceFactsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_agents_connectors_check_in_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_facts_request:
+ :type device_facts_request: DeviceFactsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_check_in_create_serialize(
+ device_facts_request=device_facts_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_check_in_create_with_http_info(
+ self,
+ device_facts_request: Optional[DeviceFactsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_agents_connectors_check_in_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_facts_request:
+ :type device_facts_request: DeviceFactsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_check_in_create_serialize(
+ device_facts_request=device_facts_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_check_in_create_without_preload_content(
+ self,
+ device_facts_request: Optional[DeviceFactsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_check_in_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_facts_request:
+ :type device_facts_request: DeviceFactsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_check_in_create_serialize(
+ device_facts_request=device_facts_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_check_in_create_serialize(
+ self,
+ device_facts_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if device_facts_request is not None:
+ _body_params = device_facts_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/connectors/check_in/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_create(
+ self,
+ agent_connector_request: AgentConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentConnector:
+ """endpoints_agents_connectors_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param agent_connector_request: (required)
+ :type agent_connector_request: AgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_create_serialize(
+ agent_connector_request=agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_create_with_http_info(
+ self,
+ agent_connector_request: AgentConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentConnector]:
+ """endpoints_agents_connectors_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param agent_connector_request: (required)
+ :type agent_connector_request: AgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_create_serialize(
+ agent_connector_request=agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_create_without_preload_content(
+ self,
+ agent_connector_request: AgentConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param agent_connector_request: (required)
+ :type agent_connector_request: AgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_create_serialize(
+ agent_connector_request=agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_create_serialize(
+ self,
+ agent_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if agent_connector_request is not None:
+ _body_params = agent_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_destroy(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_agents_connectors_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_destroy_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_agents_connectors_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_destroy_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_destroy_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/agents/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_enroll_create(
+ self,
+ enroll_request: EnrollRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentTokenResponse:
+ """endpoints_agents_connectors_enroll_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enroll_request: (required)
+ :type enroll_request: EnrollRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_enroll_create_serialize(
+ enroll_request=enroll_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentTokenResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_enroll_create_with_http_info(
+ self,
+ enroll_request: EnrollRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentTokenResponse]:
+ """endpoints_agents_connectors_enroll_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enroll_request: (required)
+ :type enroll_request: EnrollRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_enroll_create_serialize(
+ enroll_request=enroll_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentTokenResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_enroll_create_without_preload_content(
+ self,
+ enroll_request: EnrollRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_enroll_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enroll_request: (required)
+ :type enroll_request: EnrollRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_enroll_create_serialize(
+ enroll_request=enroll_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentTokenResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_enroll_create_serialize(
+ self,
+ enroll_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if enroll_request is not None:
+ _body_params = enroll_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/connectors/enroll/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_list(
+ self,
+ enabled: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedAgentConnectorList:
+ """endpoints_agents_connectors_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enabled:
+ :type enabled: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_list_serialize(
+ enabled=enabled,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAgentConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_list_with_http_info(
+ self,
+ enabled: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedAgentConnectorList]:
+ """endpoints_agents_connectors_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enabled:
+ :type enabled: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_list_serialize(
+ enabled=enabled,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAgentConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_list_without_preload_content(
+ self,
+ enabled: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enabled:
+ :type enabled: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_list_serialize(
+ enabled=enabled,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAgentConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_list_serialize(
+ self,
+ enabled,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if enabled is not None:
+
+ _query_params.append(('enabled', enabled))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_mdm_config_create(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ mdm_config_request: MDMConfigRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MDMConfigResponse:
+ """endpoints_agents_connectors_mdm_config_create
+
+ Generate configuration for MDM systems to deploy authentik Agent
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param mdm_config_request: (required)
+ :type mdm_config_request: MDMConfigRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_mdm_config_create_serialize(
+ connector_uuid=connector_uuid,
+ mdm_config_request=mdm_config_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MDMConfigResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_mdm_config_create_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ mdm_config_request: MDMConfigRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MDMConfigResponse]:
+ """endpoints_agents_connectors_mdm_config_create
+
+ Generate configuration for MDM systems to deploy authentik Agent
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param mdm_config_request: (required)
+ :type mdm_config_request: MDMConfigRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_mdm_config_create_serialize(
+ connector_uuid=connector_uuid,
+ mdm_config_request=mdm_config_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MDMConfigResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_mdm_config_create_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ mdm_config_request: MDMConfigRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_mdm_config_create
+
+ Generate configuration for MDM systems to deploy authentik Agent
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param mdm_config_request: (required)
+ :type mdm_config_request: MDMConfigRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_mdm_config_create_serialize(
+ connector_uuid=connector_uuid,
+ mdm_config_request=mdm_config_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MDMConfigResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_mdm_config_create_serialize(
+ self,
+ connector_uuid,
+ mdm_config_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if mdm_config_request is not None:
+ _body_params = mdm_config_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/connectors/{connector_uuid}/mdm_config/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_partial_update(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ patched_agent_connector_request: Optional[PatchedAgentConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentConnector:
+ """endpoints_agents_connectors_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_agent_connector_request:
+ :type patched_agent_connector_request: PatchedAgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_agent_connector_request=patched_agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_partial_update_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ patched_agent_connector_request: Optional[PatchedAgentConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentConnector]:
+ """endpoints_agents_connectors_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_agent_connector_request:
+ :type patched_agent_connector_request: PatchedAgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_agent_connector_request=patched_agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_partial_update_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ patched_agent_connector_request: Optional[PatchedAgentConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_agent_connector_request:
+ :type patched_agent_connector_request: PatchedAgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_agent_connector_request=patched_agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_partial_update_serialize(
+ self,
+ connector_uuid,
+ patched_agent_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_agent_connector_request is not None:
+ _body_params = patched_agent_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/agents/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_retrieve(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentConnector:
+ """endpoints_agents_connectors_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_retrieve_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentConnector]:
+ """endpoints_agents_connectors_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_retrieve_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_retrieve_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_update(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ agent_connector_request: AgentConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentConnector:
+ """endpoints_agents_connectors_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param agent_connector_request: (required)
+ :type agent_connector_request: AgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ agent_connector_request=agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_update_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ agent_connector_request: AgentConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentConnector]:
+ """endpoints_agents_connectors_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param agent_connector_request: (required)
+ :type agent_connector_request: AgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ agent_connector_request=agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_update_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ agent_connector_request: AgentConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param agent_connector_request: (required)
+ :type agent_connector_request: AgentConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ agent_connector_request=agent_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_update_serialize(
+ self,
+ connector_uuid,
+ agent_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if agent_connector_request is not None:
+ _body_params = agent_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/agents/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_connectors_used_by_list(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_agents_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_connectors_used_by_list_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_agents_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_connectors_used_by_list_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Agent Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Agent Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_connectors_used_by_list_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/connectors/{connector_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_create(
+ self,
+ enrollment_token_request: EnrollmentTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EnrollmentToken:
+ """endpoints_agents_enrollment_tokens_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enrollment_token_request: (required)
+ :type enrollment_token_request: EnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_create_serialize(
+ enrollment_token_request=enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_create_with_http_info(
+ self,
+ enrollment_token_request: EnrollmentTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EnrollmentToken]:
+ """endpoints_agents_enrollment_tokens_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enrollment_token_request: (required)
+ :type enrollment_token_request: EnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_create_serialize(
+ enrollment_token_request=enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_create_without_preload_content(
+ self,
+ enrollment_token_request: EnrollmentTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param enrollment_token_request: (required)
+ :type enrollment_token_request: EnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_create_serialize(
+ enrollment_token_request=enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_create_serialize(
+ self,
+ enrollment_token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if enrollment_token_request is not None:
+ _body_params = enrollment_token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/enrollment_tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_destroy(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_agents_enrollment_tokens_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_destroy_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_destroy_with_http_info(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_agents_enrollment_tokens_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_destroy_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_destroy_without_preload_content(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_destroy_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_destroy_serialize(
+ self,
+ token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if token_uuid is not None:
+ _path_params['token_uuid'] = token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/agents/enrollment_tokens/{token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_list(
+ self,
+ connector: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ token_uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEnrollmentTokenList:
+ """endpoints_agents_enrollment_tokens_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector:
+ :type connector: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param token_uuid:
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_list_serialize(
+ connector=connector,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEnrollmentTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_list_with_http_info(
+ self,
+ connector: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ token_uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEnrollmentTokenList]:
+ """endpoints_agents_enrollment_tokens_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector:
+ :type connector: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param token_uuid:
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_list_serialize(
+ connector=connector,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEnrollmentTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_list_without_preload_content(
+ self,
+ connector: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ token_uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param connector:
+ :type connector: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param token_uuid:
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_list_serialize(
+ connector=connector,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEnrollmentTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_list_serialize(
+ self,
+ connector,
+ ordering,
+ page,
+ page_size,
+ search,
+ token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if connector is not None:
+
+ _query_params.append(('connector', connector))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if token_uuid is not None:
+
+ _query_params.append(('token_uuid', token_uuid))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/enrollment_tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_partial_update(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ patched_enrollment_token_request: Optional[PatchedEnrollmentTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EnrollmentToken:
+ """endpoints_agents_enrollment_tokens_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param patched_enrollment_token_request:
+ :type patched_enrollment_token_request: PatchedEnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_partial_update_serialize(
+ token_uuid=token_uuid,
+ patched_enrollment_token_request=patched_enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_partial_update_with_http_info(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ patched_enrollment_token_request: Optional[PatchedEnrollmentTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EnrollmentToken]:
+ """endpoints_agents_enrollment_tokens_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param patched_enrollment_token_request:
+ :type patched_enrollment_token_request: PatchedEnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_partial_update_serialize(
+ token_uuid=token_uuid,
+ patched_enrollment_token_request=patched_enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_partial_update_without_preload_content(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ patched_enrollment_token_request: Optional[PatchedEnrollmentTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param patched_enrollment_token_request:
+ :type patched_enrollment_token_request: PatchedEnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_partial_update_serialize(
+ token_uuid=token_uuid,
+ patched_enrollment_token_request=patched_enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_partial_update_serialize(
+ self,
+ token_uuid,
+ patched_enrollment_token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if token_uuid is not None:
+ _path_params['token_uuid'] = token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_enrollment_token_request is not None:
+ _body_params = patched_enrollment_token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/agents/enrollment_tokens/{token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_retrieve(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EnrollmentToken:
+ """endpoints_agents_enrollment_tokens_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_retrieve_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_retrieve_with_http_info(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EnrollmentToken]:
+ """endpoints_agents_enrollment_tokens_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_retrieve_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_retrieve_without_preload_content(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_retrieve_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_retrieve_serialize(
+ self,
+ token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if token_uuid is not None:
+ _path_params['token_uuid'] = token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/enrollment_tokens/{token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_update(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ enrollment_token_request: EnrollmentTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EnrollmentToken:
+ """endpoints_agents_enrollment_tokens_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param enrollment_token_request: (required)
+ :type enrollment_token_request: EnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_update_serialize(
+ token_uuid=token_uuid,
+ enrollment_token_request=enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_update_with_http_info(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ enrollment_token_request: EnrollmentTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EnrollmentToken]:
+ """endpoints_agents_enrollment_tokens_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param enrollment_token_request: (required)
+ :type enrollment_token_request: EnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_update_serialize(
+ token_uuid=token_uuid,
+ enrollment_token_request=enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_update_without_preload_content(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ enrollment_token_request: EnrollmentTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param enrollment_token_request: (required)
+ :type enrollment_token_request: EnrollmentTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_update_serialize(
+ token_uuid=token_uuid,
+ enrollment_token_request=enrollment_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EnrollmentToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_update_serialize(
+ self,
+ token_uuid,
+ enrollment_token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if token_uuid is not None:
+ _path_params['token_uuid'] = token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if enrollment_token_request is not None:
+ _body_params = enrollment_token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/agents/enrollment_tokens/{token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_used_by_list(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_agents_enrollment_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_used_by_list_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_used_by_list_with_http_info(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_agents_enrollment_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_used_by_list_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_used_by_list_without_preload_content(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_used_by_list_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_used_by_list_serialize(
+ self,
+ token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if token_uuid is not None:
+ _path_params['token_uuid'] = token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/enrollment_tokens/{token_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_view_key_retrieve(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TokenView:
+ """endpoints_agents_enrollment_tokens_view_key_retrieve
+
+ Return token key and log access
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_view_key_retrieve_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenView",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_view_key_retrieve_with_http_info(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TokenView]:
+ """endpoints_agents_enrollment_tokens_view_key_retrieve
+
+ Return token key and log access
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_view_key_retrieve_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenView",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_enrollment_tokens_view_key_retrieve_without_preload_content(
+ self,
+ token_uuid: Annotated[UUID, Field(description="A UUID string identifying this Enrollment Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_enrollment_tokens_view_key_retrieve
+
+ Return token key and log access
+
+ :param token_uuid: A UUID string identifying this Enrollment Token. (required)
+ :type token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_enrollment_tokens_view_key_retrieve_serialize(
+ token_uuid=token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenView",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_enrollment_tokens_view_key_retrieve_serialize(
+ self,
+ token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if token_uuid is not None:
+ _path_params['token_uuid'] = token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/enrollment_tokens/{token_uuid}/view_key/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_create(
+ self,
+ apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AppleIndependentSecureEnclave:
+ """endpoints_agents_psso_ise_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param apple_independent_secure_enclave_request: (required)
+ :type apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_create_serialize(
+ apple_independent_secure_enclave_request=apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_create_with_http_info(
+ self,
+ apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AppleIndependentSecureEnclave]:
+ """endpoints_agents_psso_ise_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param apple_independent_secure_enclave_request: (required)
+ :type apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_create_serialize(
+ apple_independent_secure_enclave_request=apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_create_without_preload_content(
+ self,
+ apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_create
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param apple_independent_secure_enclave_request: (required)
+ :type apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_create_serialize(
+ apple_independent_secure_enclave_request=apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_create_serialize(
+ self,
+ apple_independent_secure_enclave_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if apple_independent_secure_enclave_request is not None:
+ _body_params = apple_independent_secure_enclave_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/psso/ise/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_agents_psso_ise_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_agents_psso_ise_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/agents/psso/ise/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_list(
+ self,
+ apple_enclave_key_id: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedAppleIndependentSecureEnclaveList:
+ """endpoints_agents_psso_ise_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param apple_enclave_key_id:
+ :type apple_enclave_key_id: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_list_serialize(
+ apple_enclave_key_id=apple_enclave_key_id,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAppleIndependentSecureEnclaveList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_list_with_http_info(
+ self,
+ apple_enclave_key_id: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedAppleIndependentSecureEnclaveList]:
+ """endpoints_agents_psso_ise_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param apple_enclave_key_id:
+ :type apple_enclave_key_id: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_list_serialize(
+ apple_enclave_key_id=apple_enclave_key_id,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAppleIndependentSecureEnclaveList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_list_without_preload_content(
+ self,
+ apple_enclave_key_id: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param apple_enclave_key_id:
+ :type apple_enclave_key_id: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_list_serialize(
+ apple_enclave_key_id=apple_enclave_key_id,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedAppleIndependentSecureEnclaveList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_list_serialize(
+ self,
+ apple_enclave_key_id,
+ ordering,
+ page,
+ page_size,
+ search,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if apple_enclave_key_id is not None:
+
+ _query_params.append(('apple_enclave_key_id', apple_enclave_key_id))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/psso/ise/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ patched_apple_independent_secure_enclave_request: Optional[PatchedAppleIndependentSecureEnclaveRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AppleIndependentSecureEnclave:
+ """endpoints_agents_psso_ise_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param patched_apple_independent_secure_enclave_request:
+ :type patched_apple_independent_secure_enclave_request: PatchedAppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_partial_update_serialize(
+ uuid=uuid,
+ patched_apple_independent_secure_enclave_request=patched_apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ patched_apple_independent_secure_enclave_request: Optional[PatchedAppleIndependentSecureEnclaveRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AppleIndependentSecureEnclave]:
+ """endpoints_agents_psso_ise_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param patched_apple_independent_secure_enclave_request:
+ :type patched_apple_independent_secure_enclave_request: PatchedAppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_partial_update_serialize(
+ uuid=uuid,
+ patched_apple_independent_secure_enclave_request=patched_apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ patched_apple_independent_secure_enclave_request: Optional[PatchedAppleIndependentSecureEnclaveRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param patched_apple_independent_secure_enclave_request:
+ :type patched_apple_independent_secure_enclave_request: PatchedAppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_partial_update_serialize(
+ uuid=uuid,
+ patched_apple_independent_secure_enclave_request=patched_apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_partial_update_serialize(
+ self,
+ uuid,
+ patched_apple_independent_secure_enclave_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_apple_independent_secure_enclave_request is not None:
+ _body_params = patched_apple_independent_secure_enclave_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/agents/psso/ise/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AppleIndependentSecureEnclave:
+ """endpoints_agents_psso_ise_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AppleIndependentSecureEnclave]:
+ """endpoints_agents_psso_ise_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/psso/ise/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AppleIndependentSecureEnclave:
+ """endpoints_agents_psso_ise_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param apple_independent_secure_enclave_request: (required)
+ :type apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_update_serialize(
+ uuid=uuid,
+ apple_independent_secure_enclave_request=apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AppleIndependentSecureEnclave]:
+ """endpoints_agents_psso_ise_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param apple_independent_secure_enclave_request: (required)
+ :type apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_update_serialize(
+ uuid=uuid,
+ apple_independent_secure_enclave_request=apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param apple_independent_secure_enclave_request: (required)
+ :type apple_independent_secure_enclave_request: AppleIndependentSecureEnclaveRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_update_serialize(
+ uuid=uuid,
+ apple_independent_secure_enclave_request=apple_independent_secure_enclave_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AppleIndependentSecureEnclave",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_update_serialize(
+ self,
+ uuid,
+ apple_independent_secure_enclave_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if apple_independent_secure_enclave_request is not None:
+ _body_params = apple_independent_secure_enclave_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/agents/psso/ise/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_agents_psso_ise_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_agents_psso_ise_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_ise_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Apple Independent Secure Enclave.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_ise_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Apple Independent Secure Enclave. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_ise_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_ise_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/agents/psso/ise/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_register_device_create(
+ self,
+ agent_psso_device_registration_request: AgentPSSODeviceRegistrationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> AgentPSSODeviceRegistrationResponse:
+ """endpoints_agents_psso_register_device_create
+
+
+ :param agent_psso_device_registration_request: (required)
+ :type agent_psso_device_registration_request: AgentPSSODeviceRegistrationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_register_device_create_serialize(
+ agent_psso_device_registration_request=agent_psso_device_registration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentPSSODeviceRegistrationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_register_device_create_with_http_info(
+ self,
+ agent_psso_device_registration_request: AgentPSSODeviceRegistrationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[AgentPSSODeviceRegistrationResponse]:
+ """endpoints_agents_psso_register_device_create
+
+
+ :param agent_psso_device_registration_request: (required)
+ :type agent_psso_device_registration_request: AgentPSSODeviceRegistrationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_register_device_create_serialize(
+ agent_psso_device_registration_request=agent_psso_device_registration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentPSSODeviceRegistrationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_register_device_create_without_preload_content(
+ self,
+ agent_psso_device_registration_request: AgentPSSODeviceRegistrationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_register_device_create
+
+
+ :param agent_psso_device_registration_request: (required)
+ :type agent_psso_device_registration_request: AgentPSSODeviceRegistrationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_register_device_create_serialize(
+ agent_psso_device_registration_request=agent_psso_device_registration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "AgentPSSODeviceRegistrationResponse",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_register_device_create_serialize(
+ self,
+ agent_psso_device_registration_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if agent_psso_device_registration_request is not None:
+ _body_params = agent_psso_device_registration_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/psso/register/device/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_agents_psso_register_user_create(
+ self,
+ agent_psso_user_registration_request: AgentPSSOUserRegistrationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UserSelf:
+ """endpoints_agents_psso_register_user_create
+
+
+ :param agent_psso_user_registration_request: (required)
+ :type agent_psso_user_registration_request: AgentPSSOUserRegistrationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_register_user_create_serialize(
+ agent_psso_user_registration_request=agent_psso_user_registration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserSelf",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_agents_psso_register_user_create_with_http_info(
+ self,
+ agent_psso_user_registration_request: AgentPSSOUserRegistrationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UserSelf]:
+ """endpoints_agents_psso_register_user_create
+
+
+ :param agent_psso_user_registration_request: (required)
+ :type agent_psso_user_registration_request: AgentPSSOUserRegistrationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_register_user_create_serialize(
+ agent_psso_user_registration_request=agent_psso_user_registration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserSelf",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_agents_psso_register_user_create_without_preload_content(
+ self,
+ agent_psso_user_registration_request: AgentPSSOUserRegistrationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_agents_psso_register_user_create
+
+
+ :param agent_psso_user_registration_request: (required)
+ :type agent_psso_user_registration_request: AgentPSSOUserRegistrationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_agents_psso_register_user_create_serialize(
+ agent_psso_user_registration_request=agent_psso_user_registration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UserSelf",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_agents_psso_register_user_create_serialize(
+ self,
+ agent_psso_user_registration_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if agent_psso_user_registration_request is not None:
+ _body_params = agent_psso_user_registration_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/agents/psso/register/user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_connectors_destroy(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_connectors_destroy
+
+ Connector Viewset
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_connectors_destroy_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_connectors_destroy
+
+ Connector Viewset
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_connectors_destroy_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_connectors_destroy
+
+ Connector Viewset
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_connectors_destroy_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_connectors_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedConnectorList:
+ """endpoints_connectors_list
+
+ Connector Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_connectors_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedConnectorList]:
+ """endpoints_connectors_list
+
+ Connector Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_connectors_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_connectors_list
+
+ Connector Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_connectors_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_connectors_retrieve(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Connector:
+ """endpoints_connectors_retrieve
+
+ Connector Viewset
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Connector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_connectors_retrieve_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Connector]:
+ """endpoints_connectors_retrieve
+
+ Connector Viewset
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Connector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_connectors_retrieve_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_connectors_retrieve
+
+ Connector Viewset
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Connector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_connectors_retrieve_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_connectors_types_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """endpoints_connectors_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_connectors_types_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """endpoints_connectors_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_connectors_types_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_connectors_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_connectors_types_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/connectors/types/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_connectors_used_by_list(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_connectors_used_by_list_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_connectors_used_by_list_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_connectors_used_by_list_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/connectors/{connector_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_create(
+ self,
+ device_access_group_request: DeviceAccessGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceAccessGroup:
+ """endpoints_device_access_groups_create
+
+ DeviceAccessGroup Viewset
+
+ :param device_access_group_request: (required)
+ :type device_access_group_request: DeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_create_serialize(
+ device_access_group_request=device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_create_with_http_info(
+ self,
+ device_access_group_request: DeviceAccessGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceAccessGroup]:
+ """endpoints_device_access_groups_create
+
+ DeviceAccessGroup Viewset
+
+ :param device_access_group_request: (required)
+ :type device_access_group_request: DeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_create_serialize(
+ device_access_group_request=device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_create_without_preload_content(
+ self,
+ device_access_group_request: DeviceAccessGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_create
+
+ DeviceAccessGroup Viewset
+
+ :param device_access_group_request: (required)
+ :type device_access_group_request: DeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_create_serialize(
+ device_access_group_request=device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_create_serialize(
+ self,
+ device_access_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if device_access_group_request is not None:
+ _body_params = device_access_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/device_access_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_destroy(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_device_access_groups_destroy
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_destroy_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_device_access_groups_destroy
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_destroy_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_destroy
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_destroy_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/device_access_groups/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDeviceAccessGroupList:
+ """endpoints_device_access_groups_list
+
+ DeviceAccessGroup Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDeviceAccessGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDeviceAccessGroupList]:
+ """endpoints_device_access_groups_list
+
+ DeviceAccessGroup Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDeviceAccessGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_list
+
+ DeviceAccessGroup Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDeviceAccessGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ pbm_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if pbm_uuid is not None:
+
+ _query_params.append(('pbm_uuid', pbm_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/device_access_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_partial_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ patched_device_access_group_request: Optional[PatchedDeviceAccessGroupRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceAccessGroup:
+ """endpoints_device_access_groups_partial_update
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param patched_device_access_group_request:
+ :type patched_device_access_group_request: PatchedDeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_device_access_group_request=patched_device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_partial_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ patched_device_access_group_request: Optional[PatchedDeviceAccessGroupRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceAccessGroup]:
+ """endpoints_device_access_groups_partial_update
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param patched_device_access_group_request:
+ :type patched_device_access_group_request: PatchedDeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_device_access_group_request=patched_device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_partial_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ patched_device_access_group_request: Optional[PatchedDeviceAccessGroupRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_partial_update
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param patched_device_access_group_request:
+ :type patched_device_access_group_request: PatchedDeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_device_access_group_request=patched_device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_partial_update_serialize(
+ self,
+ pbm_uuid,
+ patched_device_access_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_device_access_group_request is not None:
+ _body_params = patched_device_access_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/device_access_groups/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_retrieve(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceAccessGroup:
+ """endpoints_device_access_groups_retrieve
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_retrieve_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceAccessGroup]:
+ """endpoints_device_access_groups_retrieve
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_retrieve_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_retrieve
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_retrieve_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/device_access_groups/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ device_access_group_request: DeviceAccessGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceAccessGroup:
+ """endpoints_device_access_groups_update
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param device_access_group_request: (required)
+ :type device_access_group_request: DeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_update_serialize(
+ pbm_uuid=pbm_uuid,
+ device_access_group_request=device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ device_access_group_request: DeviceAccessGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceAccessGroup]:
+ """endpoints_device_access_groups_update
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param device_access_group_request: (required)
+ :type device_access_group_request: DeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_update_serialize(
+ pbm_uuid=pbm_uuid,
+ device_access_group_request=device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ device_access_group_request: DeviceAccessGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_update
+
+ DeviceAccessGroup Viewset
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param device_access_group_request: (required)
+ :type device_access_group_request: DeviceAccessGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_update_serialize(
+ pbm_uuid=pbm_uuid,
+ device_access_group_request=device_access_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceAccessGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_update_serialize(
+ self,
+ pbm_uuid,
+ device_access_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if device_access_group_request is not None:
+ _body_params = device_access_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/device_access_groups/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_access_groups_used_by_list(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_device_access_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_access_groups_used_by_list_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_device_access_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_access_groups_used_by_list_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device access group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_access_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Device access group. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_access_groups_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_access_groups_used_by_list_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/device_access_groups/{pbm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_create(
+ self,
+ device_user_binding_request: DeviceUserBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceUserBinding:
+ """endpoints_device_bindings_create
+
+ PolicyBinding Viewset
+
+ :param device_user_binding_request: (required)
+ :type device_user_binding_request: DeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_create_serialize(
+ device_user_binding_request=device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_create_with_http_info(
+ self,
+ device_user_binding_request: DeviceUserBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceUserBinding]:
+ """endpoints_device_bindings_create
+
+ PolicyBinding Viewset
+
+ :param device_user_binding_request: (required)
+ :type device_user_binding_request: DeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_create_serialize(
+ device_user_binding_request=device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_create_without_preload_content(
+ self,
+ device_user_binding_request: DeviceUserBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_create
+
+ PolicyBinding Viewset
+
+ :param device_user_binding_request: (required)
+ :type device_user_binding_request: DeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_create_serialize(
+ device_user_binding_request=device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_create_serialize(
+ self,
+ device_user_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if device_user_binding_request is not None:
+ _body_params = device_user_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/device_bindings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_destroy(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_device_bindings_destroy
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_destroy_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_destroy_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_device_bindings_destroy
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_destroy_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_destroy_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_destroy
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_destroy_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_destroy_serialize(
+ self,
+ policy_binding_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/device_bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_list(
+ self,
+ enabled: Optional[StrictBool] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy: Optional[UUID] = None,
+ policy__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ target: Optional[UUID] = None,
+ target_in: Optional[List[UUID]] = None,
+ timeout: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDeviceUserBindingList:
+ """endpoints_device_bindings_list
+
+ PolicyBinding Viewset
+
+ :param enabled:
+ :type enabled: bool
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy:
+ :type policy: UUID
+ :param policy__isnull:
+ :type policy__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param target:
+ :type target: UUID
+ :param target_in:
+ :type target_in: List[UUID]
+ :param timeout:
+ :type timeout: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_list_serialize(
+ enabled=enabled,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy=policy,
+ policy__isnull=policy__isnull,
+ search=search,
+ target=target,
+ target_in=target_in,
+ timeout=timeout,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDeviceUserBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_list_with_http_info(
+ self,
+ enabled: Optional[StrictBool] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy: Optional[UUID] = None,
+ policy__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ target: Optional[UUID] = None,
+ target_in: Optional[List[UUID]] = None,
+ timeout: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDeviceUserBindingList]:
+ """endpoints_device_bindings_list
+
+ PolicyBinding Viewset
+
+ :param enabled:
+ :type enabled: bool
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy:
+ :type policy: UUID
+ :param policy__isnull:
+ :type policy__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param target:
+ :type target: UUID
+ :param target_in:
+ :type target_in: List[UUID]
+ :param timeout:
+ :type timeout: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_list_serialize(
+ enabled=enabled,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy=policy,
+ policy__isnull=policy__isnull,
+ search=search,
+ target=target,
+ target_in=target_in,
+ timeout=timeout,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDeviceUserBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_list_without_preload_content(
+ self,
+ enabled: Optional[StrictBool] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy: Optional[UUID] = None,
+ policy__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ target: Optional[UUID] = None,
+ target_in: Optional[List[UUID]] = None,
+ timeout: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_list
+
+ PolicyBinding Viewset
+
+ :param enabled:
+ :type enabled: bool
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy:
+ :type policy: UUID
+ :param policy__isnull:
+ :type policy__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param target:
+ :type target: UUID
+ :param target_in:
+ :type target_in: List[UUID]
+ :param timeout:
+ :type timeout: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_list_serialize(
+ enabled=enabled,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy=policy,
+ policy__isnull=policy__isnull,
+ search=search,
+ target=target,
+ target_in=target_in,
+ timeout=timeout,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDeviceUserBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_list_serialize(
+ self,
+ enabled,
+ order,
+ ordering,
+ page,
+ page_size,
+ policy,
+ policy__isnull,
+ search,
+ target,
+ target_in,
+ timeout,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'target_in': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if enabled is not None:
+
+ _query_params.append(('enabled', enabled))
+
+ if order is not None:
+
+ _query_params.append(('order', order))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy is not None:
+
+ _query_params.append(('policy', policy))
+
+ if policy__isnull is not None:
+
+ _query_params.append(('policy__isnull', policy__isnull))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if target is not None:
+
+ _query_params.append(('target', target))
+
+ if target_in is not None:
+
+ _query_params.append(('target_in', target_in))
+
+ if timeout is not None:
+
+ _query_params.append(('timeout', timeout))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/device_bindings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_partial_update(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ patched_device_user_binding_request: Optional[PatchedDeviceUserBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceUserBinding:
+ """endpoints_device_bindings_partial_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param patched_device_user_binding_request:
+ :type patched_device_user_binding_request: PatchedDeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_partial_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ patched_device_user_binding_request=patched_device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_partial_update_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ patched_device_user_binding_request: Optional[PatchedDeviceUserBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceUserBinding]:
+ """endpoints_device_bindings_partial_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param patched_device_user_binding_request:
+ :type patched_device_user_binding_request: PatchedDeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_partial_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ patched_device_user_binding_request=patched_device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_partial_update_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ patched_device_user_binding_request: Optional[PatchedDeviceUserBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_partial_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param patched_device_user_binding_request:
+ :type patched_device_user_binding_request: PatchedDeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_partial_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ patched_device_user_binding_request=patched_device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_partial_update_serialize(
+ self,
+ policy_binding_uuid,
+ patched_device_user_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_device_user_binding_request is not None:
+ _body_params = patched_device_user_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/device_bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_retrieve(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceUserBinding:
+ """endpoints_device_bindings_retrieve
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_retrieve_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_retrieve_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceUserBinding]:
+ """endpoints_device_bindings_retrieve
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_retrieve_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_retrieve_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_retrieve
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_retrieve_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_retrieve_serialize(
+ self,
+ policy_binding_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/device_bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_update(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ device_user_binding_request: DeviceUserBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceUserBinding:
+ """endpoints_device_bindings_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param device_user_binding_request: (required)
+ :type device_user_binding_request: DeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ device_user_binding_request=device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_update_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ device_user_binding_request: DeviceUserBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceUserBinding]:
+ """endpoints_device_bindings_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param device_user_binding_request: (required)
+ :type device_user_binding_request: DeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ device_user_binding_request=device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_update_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ device_user_binding_request: DeviceUserBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param device_user_binding_request: (required)
+ :type device_user_binding_request: DeviceUserBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ device_user_binding_request=device_user_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceUserBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_update_serialize(
+ self,
+ policy_binding_uuid,
+ device_user_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if device_user_binding_request is not None:
+ _body_params = device_user_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/device_bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_device_bindings_used_by_list(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_device_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_used_by_list_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_device_bindings_used_by_list_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_device_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_used_by_list_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_device_bindings_used_by_list_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device User binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_device_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_binding_uuid: A UUID string identifying this Device User binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_device_bindings_used_by_list_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_device_bindings_used_by_list_serialize(
+ self,
+ policy_binding_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/device_bindings/{policy_binding_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_destroy(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_devices_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_destroy_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_destroy_with_http_info(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_devices_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_destroy_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_destroy_without_preload_content(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_destroy
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_destroy_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_destroy_serialize(
+ self,
+ device_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if device_uuid is not None:
+ _path_params['device_uuid'] = device_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/devices/{device_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_list(
+ self,
+ identifier: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEndpointDeviceList:
+ """endpoints_devices_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param identifier:
+ :type identifier: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_list_serialize(
+ identifier=identifier,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_list_with_http_info(
+ self,
+ identifier: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEndpointDeviceList]:
+ """endpoints_devices_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param identifier:
+ :type identifier: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_list_serialize(
+ identifier=identifier,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_list_without_preload_content(
+ self,
+ identifier: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_list
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param identifier:
+ :type identifier: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_list_serialize(
+ identifier=identifier,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEndpointDeviceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_list_serialize(
+ self,
+ identifier,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if identifier is not None:
+
+ _query_params.append(('identifier', identifier))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/devices/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_partial_update(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ patched_endpoint_device_request: Optional[PatchedEndpointDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EndpointDevice:
+ """endpoints_devices_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param patched_endpoint_device_request:
+ :type patched_endpoint_device_request: PatchedEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_partial_update_serialize(
+ device_uuid=device_uuid,
+ patched_endpoint_device_request=patched_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_partial_update_with_http_info(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ patched_endpoint_device_request: Optional[PatchedEndpointDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EndpointDevice]:
+ """endpoints_devices_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param patched_endpoint_device_request:
+ :type patched_endpoint_device_request: PatchedEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_partial_update_serialize(
+ device_uuid=device_uuid,
+ patched_endpoint_device_request=patched_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_partial_update_without_preload_content(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ patched_endpoint_device_request: Optional[PatchedEndpointDeviceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_partial_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param patched_endpoint_device_request:
+ :type patched_endpoint_device_request: PatchedEndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_partial_update_serialize(
+ device_uuid=device_uuid,
+ patched_endpoint_device_request=patched_endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_partial_update_serialize(
+ self,
+ device_uuid,
+ patched_endpoint_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if device_uuid is not None:
+ _path_params['device_uuid'] = device_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_endpoint_device_request is not None:
+ _body_params = patched_endpoint_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/devices/{device_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_retrieve(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EndpointDeviceDetails:
+ """endpoints_devices_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_retrieve_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDeviceDetails",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_retrieve_with_http_info(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EndpointDeviceDetails]:
+ """endpoints_devices_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_retrieve_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDeviceDetails",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_retrieve_without_preload_content(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_retrieve_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDeviceDetails",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_retrieve_serialize(
+ self,
+ device_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if device_uuid is not None:
+ _path_params['device_uuid'] = device_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/devices/{device_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_summary_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DeviceSummary:
+ """endpoints_devices_summary_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_summary_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceSummary",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_summary_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DeviceSummary]:
+ """endpoints_devices_summary_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_summary_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceSummary",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_summary_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_summary_retrieve
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_summary_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DeviceSummary",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_summary_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/devices/summary/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_update(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ endpoint_device_request: EndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EndpointDevice:
+ """endpoints_devices_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param endpoint_device_request: (required)
+ :type endpoint_device_request: EndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_update_serialize(
+ device_uuid=device_uuid,
+ endpoint_device_request=endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_update_with_http_info(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ endpoint_device_request: EndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EndpointDevice]:
+ """endpoints_devices_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param endpoint_device_request: (required)
+ :type endpoint_device_request: EndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_update_serialize(
+ device_uuid=device_uuid,
+ endpoint_device_request=endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_update_without_preload_content(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ endpoint_device_request: EndpointDeviceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_update
+
+ Mixin to add a used_by endpoint to return a list of all objects using this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param endpoint_device_request: (required)
+ :type endpoint_device_request: EndpointDeviceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_update_serialize(
+ device_uuid=device_uuid,
+ endpoint_device_request=endpoint_device_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EndpointDevice",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_update_serialize(
+ self,
+ device_uuid,
+ endpoint_device_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if device_uuid is not None:
+ _path_params['device_uuid'] = device_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if endpoint_device_request is not None:
+ _body_params = endpoint_device_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/devices/{device_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_devices_used_by_list(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_devices_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_used_by_list_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_devices_used_by_list_with_http_info(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_devices_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_used_by_list_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_devices_used_by_list_without_preload_content(
+ self,
+ device_uuid: Annotated[UUID, Field(description="A UUID string identifying this Device.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_devices_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param device_uuid: A UUID string identifying this Device. (required)
+ :type device_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_devices_used_by_list_serialize(
+ device_uuid=device_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_devices_used_by_list_serialize(
+ self,
+ device_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if device_uuid is not None:
+ _path_params['device_uuid'] = device_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/devices/{device_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_create(
+ self,
+ fleet_connector_request: FleetConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FleetConnector:
+ """endpoints_fleet_connectors_create
+
+ FleetConnector Viewset
+
+ :param fleet_connector_request: (required)
+ :type fleet_connector_request: FleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_create_serialize(
+ fleet_connector_request=fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_create_with_http_info(
+ self,
+ fleet_connector_request: FleetConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FleetConnector]:
+ """endpoints_fleet_connectors_create
+
+ FleetConnector Viewset
+
+ :param fleet_connector_request: (required)
+ :type fleet_connector_request: FleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_create_serialize(
+ fleet_connector_request=fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_create_without_preload_content(
+ self,
+ fleet_connector_request: FleetConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_create
+
+ FleetConnector Viewset
+
+ :param fleet_connector_request: (required)
+ :type fleet_connector_request: FleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_create_serialize(
+ fleet_connector_request=fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_create_serialize(
+ self,
+ fleet_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if fleet_connector_request is not None:
+ _body_params = fleet_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/fleet/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_destroy(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_fleet_connectors_destroy
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_destroy_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_fleet_connectors_destroy
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_destroy_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_destroy
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_destroy_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/fleet/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedFleetConnectorList:
+ """endpoints_fleet_connectors_list
+
+ FleetConnector Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFleetConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedFleetConnectorList]:
+ """endpoints_fleet_connectors_list
+
+ FleetConnector Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFleetConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_list
+
+ FleetConnector Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFleetConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/fleet/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_partial_update(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ patched_fleet_connector_request: Optional[PatchedFleetConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FleetConnector:
+ """endpoints_fleet_connectors_partial_update
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_fleet_connector_request:
+ :type patched_fleet_connector_request: PatchedFleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_fleet_connector_request=patched_fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_partial_update_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ patched_fleet_connector_request: Optional[PatchedFleetConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FleetConnector]:
+ """endpoints_fleet_connectors_partial_update
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_fleet_connector_request:
+ :type patched_fleet_connector_request: PatchedFleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_fleet_connector_request=patched_fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_partial_update_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ patched_fleet_connector_request: Optional[PatchedFleetConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_partial_update
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_fleet_connector_request:
+ :type patched_fleet_connector_request: PatchedFleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_fleet_connector_request=patched_fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_partial_update_serialize(
+ self,
+ connector_uuid,
+ patched_fleet_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_fleet_connector_request is not None:
+ _body_params = patched_fleet_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/fleet/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_retrieve(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FleetConnector:
+ """endpoints_fleet_connectors_retrieve
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_retrieve_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FleetConnector]:
+ """endpoints_fleet_connectors_retrieve
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_retrieve_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_retrieve
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_retrieve_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/fleet/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_update(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ fleet_connector_request: FleetConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FleetConnector:
+ """endpoints_fleet_connectors_update
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param fleet_connector_request: (required)
+ :type fleet_connector_request: FleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ fleet_connector_request=fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_update_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ fleet_connector_request: FleetConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FleetConnector]:
+ """endpoints_fleet_connectors_update
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param fleet_connector_request: (required)
+ :type fleet_connector_request: FleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ fleet_connector_request=fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_update_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ fleet_connector_request: FleetConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_update
+
+ FleetConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param fleet_connector_request: (required)
+ :type fleet_connector_request: FleetConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ fleet_connector_request=fleet_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FleetConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_update_serialize(
+ self,
+ connector_uuid,
+ fleet_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if fleet_connector_request is not None:
+ _body_params = fleet_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/fleet/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_fleet_connectors_used_by_list(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_fleet_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_fleet_connectors_used_by_list_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_fleet_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_fleet_connectors_used_by_list_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Fleet Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_fleet_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Fleet Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_fleet_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_fleet_connectors_used_by_list_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/fleet/connectors/{connector_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_create(
+ self,
+ google_chrome_connector_request: GoogleChromeConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleChromeConnector:
+ """endpoints_google_chrome_connectors_create
+
+ GoogleChromeConnector Viewset
+
+ :param google_chrome_connector_request: (required)
+ :type google_chrome_connector_request: GoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_create_serialize(
+ google_chrome_connector_request=google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_create_with_http_info(
+ self,
+ google_chrome_connector_request: GoogleChromeConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleChromeConnector]:
+ """endpoints_google_chrome_connectors_create
+
+ GoogleChromeConnector Viewset
+
+ :param google_chrome_connector_request: (required)
+ :type google_chrome_connector_request: GoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_create_serialize(
+ google_chrome_connector_request=google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_create_without_preload_content(
+ self,
+ google_chrome_connector_request: GoogleChromeConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_create
+
+ GoogleChromeConnector Viewset
+
+ :param google_chrome_connector_request: (required)
+ :type google_chrome_connector_request: GoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_create_serialize(
+ google_chrome_connector_request=google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_create_serialize(
+ self,
+ google_chrome_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_chrome_connector_request is not None:
+ _body_params = google_chrome_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/endpoints/google_chrome/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_destroy(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """endpoints_google_chrome_connectors_destroy
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_destroy_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """endpoints_google_chrome_connectors_destroy
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_destroy_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_destroy
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_destroy_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_destroy_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/endpoints/google_chrome/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleChromeConnectorList:
+ """endpoints_google_chrome_connectors_list
+
+ GoogleChromeConnector Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleChromeConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleChromeConnectorList]:
+ """endpoints_google_chrome_connectors_list
+
+ GoogleChromeConnector Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleChromeConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_list
+
+ GoogleChromeConnector Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleChromeConnectorList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/google_chrome/connectors/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_partial_update(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ patched_google_chrome_connector_request: Optional[PatchedGoogleChromeConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleChromeConnector:
+ """endpoints_google_chrome_connectors_partial_update
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_google_chrome_connector_request:
+ :type patched_google_chrome_connector_request: PatchedGoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_google_chrome_connector_request=patched_google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_partial_update_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ patched_google_chrome_connector_request: Optional[PatchedGoogleChromeConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleChromeConnector]:
+ """endpoints_google_chrome_connectors_partial_update
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_google_chrome_connector_request:
+ :type patched_google_chrome_connector_request: PatchedGoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_google_chrome_connector_request=patched_google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_partial_update_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ patched_google_chrome_connector_request: Optional[PatchedGoogleChromeConnectorRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_partial_update
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param patched_google_chrome_connector_request:
+ :type patched_google_chrome_connector_request: PatchedGoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_partial_update_serialize(
+ connector_uuid=connector_uuid,
+ patched_google_chrome_connector_request=patched_google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_partial_update_serialize(
+ self,
+ connector_uuid,
+ patched_google_chrome_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_google_chrome_connector_request is not None:
+ _body_params = patched_google_chrome_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/endpoints/google_chrome/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_retrieve(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleChromeConnector:
+ """endpoints_google_chrome_connectors_retrieve
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_retrieve_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleChromeConnector]:
+ """endpoints_google_chrome_connectors_retrieve
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_retrieve_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_retrieve
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_retrieve_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_retrieve_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/google_chrome/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_update(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ google_chrome_connector_request: GoogleChromeConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleChromeConnector:
+ """endpoints_google_chrome_connectors_update
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param google_chrome_connector_request: (required)
+ :type google_chrome_connector_request: GoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ google_chrome_connector_request=google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_update_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ google_chrome_connector_request: GoogleChromeConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleChromeConnector]:
+ """endpoints_google_chrome_connectors_update
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param google_chrome_connector_request: (required)
+ :type google_chrome_connector_request: GoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ google_chrome_connector_request=google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_update_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ google_chrome_connector_request: GoogleChromeConnectorRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_update
+
+ GoogleChromeConnector Viewset
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param google_chrome_connector_request: (required)
+ :type google_chrome_connector_request: GoogleChromeConnectorRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_update_serialize(
+ connector_uuid=connector_uuid,
+ google_chrome_connector_request=google_chrome_connector_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleChromeConnector",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_update_serialize(
+ self,
+ connector_uuid,
+ google_chrome_connector_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_chrome_connector_request is not None:
+ _body_params = google_chrome_connector_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/endpoints/google_chrome/connectors/{connector_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_used_by_list(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """endpoints_google_chrome_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_used_by_list_with_http_info(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """endpoints_google_chrome_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def endpoints_google_chrome_connectors_used_by_list_without_preload_content(
+ self,
+ connector_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Device Trust Connector.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """endpoints_google_chrome_connectors_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connector_uuid: A UUID string identifying this Google Device Trust Connector. (required)
+ :type connector_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._endpoints_google_chrome_connectors_used_by_list_serialize(
+ connector_uuid=connector_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _endpoints_google_chrome_connectors_used_by_list_serialize(
+ self,
+ connector_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connector_uuid is not None:
+ _path_params['connector_uuid'] = connector_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/endpoints/google_chrome/connectors/{connector_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/enterprise_api.py b/authentik_client/api/enterprise_api.py
new file mode 100644
index 000000000..a1cbf762d
--- /dev/null
+++ b/authentik_client/api/enterprise_api.py
@@ -0,0 +1,2828 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.install_id import InstallID
+from authentik_client.models.license import License
+from authentik_client.models.license_forecast import LicenseForecast
+from authentik_client.models.license_request import LicenseRequest
+from authentik_client.models.license_summary import LicenseSummary
+from authentik_client.models.paginated_license_list import PaginatedLicenseList
+from authentik_client.models.patched_license_request import PatchedLicenseRequest
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class EnterpriseApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def enterprise_license_create(
+ self,
+ license_request: LicenseRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> License:
+ """enterprise_license_create
+
+ License Viewset
+
+ :param license_request: (required)
+ :type license_request: LicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_create_serialize(
+ license_request=license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_create_with_http_info(
+ self,
+ license_request: LicenseRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[License]:
+ """enterprise_license_create
+
+ License Viewset
+
+ :param license_request: (required)
+ :type license_request: LicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_create_serialize(
+ license_request=license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_create_without_preload_content(
+ self,
+ license_request: LicenseRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_create
+
+ License Viewset
+
+ :param license_request: (required)
+ :type license_request: LicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_create_serialize(
+ license_request=license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_create_serialize(
+ self,
+ license_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if license_request is not None:
+ _body_params = license_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/enterprise/license/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_destroy(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """enterprise_license_destroy
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_destroy_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_destroy_with_http_info(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """enterprise_license_destroy
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_destroy_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_destroy_without_preload_content(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_destroy
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_destroy_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_destroy_serialize(
+ self,
+ license_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if license_uuid is not None:
+ _path_params['license_uuid'] = license_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/enterprise/license/{license_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_forecast_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LicenseForecast:
+ """enterprise_license_forecast_retrieve
+
+ Forecast how many users will be required in a year
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_forecast_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LicenseForecast",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_forecast_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LicenseForecast]:
+ """enterprise_license_forecast_retrieve
+
+ Forecast how many users will be required in a year
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_forecast_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LicenseForecast",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_forecast_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_forecast_retrieve
+
+ Forecast how many users will be required in a year
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_forecast_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LicenseForecast",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_forecast_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/enterprise/license/forecast/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_install_id_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> InstallID:
+ """enterprise_license_install_id_retrieve
+
+ Get install_id
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_install_id_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InstallID",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_install_id_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[InstallID]:
+ """enterprise_license_install_id_retrieve
+
+ Get install_id
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_install_id_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InstallID",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_install_id_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_install_id_retrieve
+
+ Get install_id
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_install_id_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InstallID",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_install_id_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/enterprise/license/install_id/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedLicenseList:
+ """enterprise_license_list
+
+ License Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLicenseList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedLicenseList]:
+ """enterprise_license_list
+
+ License Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLicenseList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_list
+
+ License Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLicenseList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/enterprise/license/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_partial_update(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ patched_license_request: Optional[PatchedLicenseRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> License:
+ """enterprise_license_partial_update
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param patched_license_request:
+ :type patched_license_request: PatchedLicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_partial_update_serialize(
+ license_uuid=license_uuid,
+ patched_license_request=patched_license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_partial_update_with_http_info(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ patched_license_request: Optional[PatchedLicenseRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[License]:
+ """enterprise_license_partial_update
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param patched_license_request:
+ :type patched_license_request: PatchedLicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_partial_update_serialize(
+ license_uuid=license_uuid,
+ patched_license_request=patched_license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_partial_update_without_preload_content(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ patched_license_request: Optional[PatchedLicenseRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_partial_update
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param patched_license_request:
+ :type patched_license_request: PatchedLicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_partial_update_serialize(
+ license_uuid=license_uuid,
+ patched_license_request=patched_license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_partial_update_serialize(
+ self,
+ license_uuid,
+ patched_license_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if license_uuid is not None:
+ _path_params['license_uuid'] = license_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_license_request is not None:
+ _body_params = patched_license_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/enterprise/license/{license_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_retrieve(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> License:
+ """enterprise_license_retrieve
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_retrieve_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_retrieve_with_http_info(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[License]:
+ """enterprise_license_retrieve
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_retrieve_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_retrieve_without_preload_content(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_retrieve
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_retrieve_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_retrieve_serialize(
+ self,
+ license_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if license_uuid is not None:
+ _path_params['license_uuid'] = license_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/enterprise/license/{license_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_summary_retrieve(
+ self,
+ cached: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LicenseSummary:
+ """enterprise_license_summary_retrieve
+
+ Get the total license status
+
+ :param cached:
+ :type cached: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_summary_retrieve_serialize(
+ cached=cached,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LicenseSummary",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_summary_retrieve_with_http_info(
+ self,
+ cached: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LicenseSummary]:
+ """enterprise_license_summary_retrieve
+
+ Get the total license status
+
+ :param cached:
+ :type cached: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_summary_retrieve_serialize(
+ cached=cached,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LicenseSummary",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_summary_retrieve_without_preload_content(
+ self,
+ cached: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_summary_retrieve
+
+ Get the total license status
+
+ :param cached:
+ :type cached: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_summary_retrieve_serialize(
+ cached=cached,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LicenseSummary",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_summary_retrieve_serialize(
+ self,
+ cached,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if cached is not None:
+
+ _query_params.append(('cached', cached))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/enterprise/license/summary/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_update(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ license_request: LicenseRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> License:
+ """enterprise_license_update
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param license_request: (required)
+ :type license_request: LicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_update_serialize(
+ license_uuid=license_uuid,
+ license_request=license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_update_with_http_info(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ license_request: LicenseRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[License]:
+ """enterprise_license_update
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param license_request: (required)
+ :type license_request: LicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_update_serialize(
+ license_uuid=license_uuid,
+ license_request=license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_update_without_preload_content(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ license_request: LicenseRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_update
+
+ License Viewset
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param license_request: (required)
+ :type license_request: LicenseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_update_serialize(
+ license_uuid=license_uuid,
+ license_request=license_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "License",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_update_serialize(
+ self,
+ license_uuid,
+ license_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if license_uuid is not None:
+ _path_params['license_uuid'] = license_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if license_request is not None:
+ _body_params = license_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/enterprise/license/{license_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def enterprise_license_used_by_list(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """enterprise_license_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_used_by_list_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def enterprise_license_used_by_list_with_http_info(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """enterprise_license_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_used_by_list_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def enterprise_license_used_by_list_without_preload_content(
+ self,
+ license_uuid: Annotated[UUID, Field(description="A UUID string identifying this License.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """enterprise_license_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param license_uuid: A UUID string identifying this License. (required)
+ :type license_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._enterprise_license_used_by_list_serialize(
+ license_uuid=license_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _enterprise_license_used_by_list_serialize(
+ self,
+ license_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if license_uuid is not None:
+ _path_params['license_uuid'] = license_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/enterprise/license/{license_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/events_api.py b/authentik_client/api/events_api.py
new file mode 100644
index 000000000..cc684509f
--- /dev/null
+++ b/authentik_client/api/events_api.py
@@ -0,0 +1,10350 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from datetime import datetime
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import Any, List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.data_export import DataExport
+from authentik_client.models.event import Event
+from authentik_client.models.event_actions import EventActions
+from authentik_client.models.event_request import EventRequest
+from authentik_client.models.event_stats import EventStats
+from authentik_client.models.event_top_per_user import EventTopPerUser
+from authentik_client.models.event_volume import EventVolume
+from authentik_client.models.notification import Notification
+from authentik_client.models.notification_request import NotificationRequest
+from authentik_client.models.notification_rule import NotificationRule
+from authentik_client.models.notification_rule_request import NotificationRuleRequest
+from authentik_client.models.notification_transport import NotificationTransport
+from authentik_client.models.notification_transport_request import NotificationTransportRequest
+from authentik_client.models.notification_transport_test import NotificationTransportTest
+from authentik_client.models.paginated_event_list import PaginatedEventList
+from authentik_client.models.paginated_notification_list import PaginatedNotificationList
+from authentik_client.models.paginated_notification_rule_list import PaginatedNotificationRuleList
+from authentik_client.models.paginated_notification_transport_list import PaginatedNotificationTransportList
+from authentik_client.models.patched_event_request import PatchedEventRequest
+from authentik_client.models.patched_notification_request import PatchedNotificationRequest
+from authentik_client.models.patched_notification_rule_request import PatchedNotificationRuleRequest
+from authentik_client.models.patched_notification_transport_request import PatchedNotificationTransportRequest
+from authentik_client.models.severity_enum import SeverityEnum
+from authentik_client.models.transport_mode_enum import TransportModeEnum
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class EventsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def events_events_actions_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """events_events_actions_list
+
+ Get all actions
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_actions_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_actions_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """events_events_actions_list
+
+ Get all actions
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_actions_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_actions_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_actions_list
+
+ Get all actions
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_actions_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_actions_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/events/actions/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_create(
+ self,
+ event_request: EventRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Event:
+ """events_events_create
+
+ Event Read-Only Viewset
+
+ :param event_request: (required)
+ :type event_request: EventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_create_serialize(
+ event_request=event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_create_with_http_info(
+ self,
+ event_request: EventRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Event]:
+ """events_events_create
+
+ Event Read-Only Viewset
+
+ :param event_request: (required)
+ :type event_request: EventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_create_serialize(
+ event_request=event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_create_without_preload_content(
+ self,
+ event_request: EventRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_create
+
+ Event Read-Only Viewset
+
+ :param event_request: (required)
+ :type event_request: EventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_create_serialize(
+ event_request=event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_create_serialize(
+ self,
+ event_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if event_request is not None:
+ _body_params = event_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/events/events/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_destroy(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """events_events_destroy
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_destroy_serialize(
+ event_uuid=event_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_destroy_with_http_info(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """events_events_destroy
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_destroy_serialize(
+ event_uuid=event_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_destroy_without_preload_content(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_destroy
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_destroy_serialize(
+ event_uuid=event_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_destroy_serialize(
+ self,
+ event_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if event_uuid is not None:
+ _path_params['event_uuid'] = event_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/events/events/{event_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_export_create(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DataExport:
+ """events_events_export_create
+
+ Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_export_create_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_export_create_with_http_info(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DataExport]:
+ """events_events_export_create
+
+ Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_export_create_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_export_create_without_preload_content(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_export_create
+
+ Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_export_create_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_export_create_serialize(
+ self,
+ action,
+ actions,
+ brand_name,
+ client_ip,
+ context_authorized_app,
+ context_device,
+ context_model_app,
+ context_model_name,
+ context_model_pk,
+ ordering,
+ search,
+ username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'actions': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if action is not None:
+
+ _query_params.append(('action', action))
+
+ if actions is not None:
+
+ _query_params.append(('actions', actions))
+
+ if brand_name is not None:
+
+ _query_params.append(('brand_name', brand_name))
+
+ if client_ip is not None:
+
+ _query_params.append(('client_ip', client_ip))
+
+ if context_authorized_app is not None:
+
+ _query_params.append(('context_authorized_app', context_authorized_app))
+
+ if context_device is not None:
+
+ _query_params.append(('context_device', context_device))
+
+ if context_model_app is not None:
+
+ _query_params.append(('context_model_app', context_model_app))
+
+ if context_model_name is not None:
+
+ _query_params.append(('context_model_name', context_model_name))
+
+ if context_model_pk is not None:
+
+ _query_params.append(('context_model_pk', context_model_pk))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if username is not None:
+
+ _query_params.append(('username', username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/events/events/export/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_list(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEventList:
+ """events_events_list
+
+ Event Read-Only Viewset
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_list_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEventList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_list_with_http_info(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEventList]:
+ """events_events_list
+
+ Event Read-Only Viewset
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_list_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEventList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_list_without_preload_content(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_list
+
+ Event Read-Only Viewset
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_list_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEventList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_list_serialize(
+ self,
+ action,
+ actions,
+ brand_name,
+ client_ip,
+ context_authorized_app,
+ context_device,
+ context_model_app,
+ context_model_name,
+ context_model_pk,
+ ordering,
+ page,
+ page_size,
+ search,
+ username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'actions': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if action is not None:
+
+ _query_params.append(('action', action))
+
+ if actions is not None:
+
+ _query_params.append(('actions', actions))
+
+ if brand_name is not None:
+
+ _query_params.append(('brand_name', brand_name))
+
+ if client_ip is not None:
+
+ _query_params.append(('client_ip', client_ip))
+
+ if context_authorized_app is not None:
+
+ _query_params.append(('context_authorized_app', context_authorized_app))
+
+ if context_device is not None:
+
+ _query_params.append(('context_device', context_device))
+
+ if context_model_app is not None:
+
+ _query_params.append(('context_model_app', context_model_app))
+
+ if context_model_name is not None:
+
+ _query_params.append(('context_model_name', context_model_name))
+
+ if context_model_pk is not None:
+
+ _query_params.append(('context_model_pk', context_model_pk))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if username is not None:
+
+ _query_params.append(('username', username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/events/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_partial_update(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ patched_event_request: Optional[PatchedEventRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Event:
+ """events_events_partial_update
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param patched_event_request:
+ :type patched_event_request: PatchedEventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_partial_update_serialize(
+ event_uuid=event_uuid,
+ patched_event_request=patched_event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_partial_update_with_http_info(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ patched_event_request: Optional[PatchedEventRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Event]:
+ """events_events_partial_update
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param patched_event_request:
+ :type patched_event_request: PatchedEventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_partial_update_serialize(
+ event_uuid=event_uuid,
+ patched_event_request=patched_event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_partial_update_without_preload_content(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ patched_event_request: Optional[PatchedEventRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_partial_update
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param patched_event_request:
+ :type patched_event_request: PatchedEventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_partial_update_serialize(
+ event_uuid=event_uuid,
+ patched_event_request=patched_event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_partial_update_serialize(
+ self,
+ event_uuid,
+ patched_event_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if event_uuid is not None:
+ _path_params['event_uuid'] = event_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_event_request is not None:
+ _body_params = patched_event_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/events/events/{event_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_retrieve(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Event:
+ """events_events_retrieve
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_retrieve_serialize(
+ event_uuid=event_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_retrieve_with_http_info(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Event]:
+ """events_events_retrieve
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_retrieve_serialize(
+ event_uuid=event_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_retrieve_without_preload_content(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_retrieve
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_retrieve_serialize(
+ event_uuid=event_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_retrieve_serialize(
+ self,
+ event_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if event_uuid is not None:
+ _path_params['event_uuid'] = event_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/events/{event_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_stats_retrieve(
+ self,
+ count_steps: Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Timedelta, format of 'weeks=3;days=2;hours=3,seconds=2'")],
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EventStats:
+ """events_events_stats_retrieve
+
+ Get event stats for specified filters and count steps
+
+ :param count_steps: Timedelta, format of 'weeks=3;days=2;hours=3,seconds=2' (required)
+ :type count_steps: List[str]
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_stats_retrieve_serialize(
+ count_steps=count_steps,
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventStats",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_stats_retrieve_with_http_info(
+ self,
+ count_steps: Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Timedelta, format of 'weeks=3;days=2;hours=3,seconds=2'")],
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EventStats]:
+ """events_events_stats_retrieve
+
+ Get event stats for specified filters and count steps
+
+ :param count_steps: Timedelta, format of 'weeks=3;days=2;hours=3,seconds=2' (required)
+ :type count_steps: List[str]
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_stats_retrieve_serialize(
+ count_steps=count_steps,
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventStats",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_stats_retrieve_without_preload_content(
+ self,
+ count_steps: Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Timedelta, format of 'weeks=3;days=2;hours=3,seconds=2'")],
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_stats_retrieve
+
+ Get event stats for specified filters and count steps
+
+ :param count_steps: Timedelta, format of 'weeks=3;days=2;hours=3,seconds=2' (required)
+ :type count_steps: List[str]
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_stats_retrieve_serialize(
+ count_steps=count_steps,
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventStats",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_stats_retrieve_serialize(
+ self,
+ count_steps,
+ action,
+ actions,
+ brand_name,
+ client_ip,
+ context_authorized_app,
+ context_device,
+ context_model_app,
+ context_model_name,
+ context_model_pk,
+ ordering,
+ search,
+ username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'count_steps': 'multi',
+ 'actions': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if action is not None:
+
+ _query_params.append(('action', action))
+
+ if actions is not None:
+
+ _query_params.append(('actions', actions))
+
+ if brand_name is not None:
+
+ _query_params.append(('brand_name', brand_name))
+
+ if client_ip is not None:
+
+ _query_params.append(('client_ip', client_ip))
+
+ if context_authorized_app is not None:
+
+ _query_params.append(('context_authorized_app', context_authorized_app))
+
+ if context_device is not None:
+
+ _query_params.append(('context_device', context_device))
+
+ if context_model_app is not None:
+
+ _query_params.append(('context_model_app', context_model_app))
+
+ if context_model_name is not None:
+
+ _query_params.append(('context_model_name', context_model_name))
+
+ if context_model_pk is not None:
+
+ _query_params.append(('context_model_pk', context_model_pk))
+
+ if count_steps is not None:
+
+ _query_params.append(('count_steps', count_steps))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if username is not None:
+
+ _query_params.append(('username', username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/events/stats/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_top_per_user_list(
+ self,
+ action: Optional[StrictStr] = None,
+ top_n: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[EventTopPerUser]:
+ """events_events_top_per_user_list
+
+ Get the top_n events grouped by user count
+
+ :param action:
+ :type action: str
+ :param top_n:
+ :type top_n: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_top_per_user_list_serialize(
+ action=action,
+ top_n=top_n,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[EventTopPerUser]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_top_per_user_list_with_http_info(
+ self,
+ action: Optional[StrictStr] = None,
+ top_n: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[EventTopPerUser]]:
+ """events_events_top_per_user_list
+
+ Get the top_n events grouped by user count
+
+ :param action:
+ :type action: str
+ :param top_n:
+ :type top_n: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_top_per_user_list_serialize(
+ action=action,
+ top_n=top_n,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[EventTopPerUser]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_top_per_user_list_without_preload_content(
+ self,
+ action: Optional[StrictStr] = None,
+ top_n: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_top_per_user_list
+
+ Get the top_n events grouped by user count
+
+ :param action:
+ :type action: str
+ :param top_n:
+ :type top_n: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_top_per_user_list_serialize(
+ action=action,
+ top_n=top_n,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[EventTopPerUser]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_top_per_user_list_serialize(
+ self,
+ action,
+ top_n,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if action is not None:
+
+ _query_params.append(('action', action))
+
+ if top_n is not None:
+
+ _query_params.append(('top_n', top_n))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/events/top_per_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_update(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ event_request: EventRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Event:
+ """events_events_update
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param event_request: (required)
+ :type event_request: EventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_update_serialize(
+ event_uuid=event_uuid,
+ event_request=event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_update_with_http_info(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ event_request: EventRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Event]:
+ """events_events_update
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param event_request: (required)
+ :type event_request: EventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_update_serialize(
+ event_uuid=event_uuid,
+ event_request=event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_update_without_preload_content(
+ self,
+ event_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event.")],
+ event_request: EventRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_update
+
+ Event Read-Only Viewset
+
+ :param event_uuid: A UUID string identifying this Event. (required)
+ :type event_uuid: UUID
+ :param event_request: (required)
+ :type event_request: EventRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_update_serialize(
+ event_uuid=event_uuid,
+ event_request=event_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Event",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_update_serialize(
+ self,
+ event_uuid,
+ event_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if event_uuid is not None:
+ _path_params['event_uuid'] = event_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if event_request is not None:
+ _body_params = event_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/events/events/{event_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_events_volume_list(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ history_days: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[EventVolume]:
+ """events_events_volume_list
+
+ Get event volume for specified filters and timeframe
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param history_days:
+ :type history_days: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_volume_list_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ history_days=history_days,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[EventVolume]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_events_volume_list_with_http_info(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ history_days: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[EventVolume]]:
+ """events_events_volume_list
+
+ Get event volume for specified filters and timeframe
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param history_days:
+ :type history_days: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_volume_list_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ history_days=history_days,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[EventVolume]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_events_volume_list_without_preload_content(
+ self,
+ action: Optional[StrictStr] = None,
+ actions: Optional[List[EventActions]] = None,
+ brand_name: Annotated[Optional[StrictStr], Field(description="Brand name")] = None,
+ client_ip: Optional[StrictStr] = None,
+ context_authorized_app: Annotated[Optional[StrictStr], Field(description="Context Authorized application")] = None,
+ context_device: Annotated[Optional[StrictStr], Field(description="Context Device Primary Key")] = None,
+ context_model_app: Annotated[Optional[StrictStr], Field(description="Context Model App")] = None,
+ context_model_name: Annotated[Optional[StrictStr], Field(description="Context Model Name")] = None,
+ context_model_pk: Annotated[Optional[StrictStr], Field(description="Context Model Primary Key")] = None,
+ history_days: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ username: Annotated[Optional[StrictStr], Field(description="Username")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_events_volume_list
+
+ Get event volume for specified filters and timeframe
+
+ :param action:
+ :type action: str
+ :param actions:
+ :type actions: List[EventActions]
+ :param brand_name: Brand name
+ :type brand_name: str
+ :param client_ip:
+ :type client_ip: str
+ :param context_authorized_app: Context Authorized application
+ :type context_authorized_app: str
+ :param context_device: Context Device Primary Key
+ :type context_device: str
+ :param context_model_app: Context Model App
+ :type context_model_app: str
+ :param context_model_name: Context Model Name
+ :type context_model_name: str
+ :param context_model_pk: Context Model Primary Key
+ :type context_model_pk: str
+ :param history_days:
+ :type history_days: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param username: Username
+ :type username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_events_volume_list_serialize(
+ action=action,
+ actions=actions,
+ brand_name=brand_name,
+ client_ip=client_ip,
+ context_authorized_app=context_authorized_app,
+ context_device=context_device,
+ context_model_app=context_model_app,
+ context_model_name=context_model_name,
+ context_model_pk=context_model_pk,
+ history_days=history_days,
+ ordering=ordering,
+ search=search,
+ username=username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[EventVolume]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_events_volume_list_serialize(
+ self,
+ action,
+ actions,
+ brand_name,
+ client_ip,
+ context_authorized_app,
+ context_device,
+ context_model_app,
+ context_model_name,
+ context_model_pk,
+ history_days,
+ ordering,
+ search,
+ username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'actions': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if action is not None:
+
+ _query_params.append(('action', action))
+
+ if actions is not None:
+
+ _query_params.append(('actions', actions))
+
+ if brand_name is not None:
+
+ _query_params.append(('brand_name', brand_name))
+
+ if client_ip is not None:
+
+ _query_params.append(('client_ip', client_ip))
+
+ if context_authorized_app is not None:
+
+ _query_params.append(('context_authorized_app', context_authorized_app))
+
+ if context_device is not None:
+
+ _query_params.append(('context_device', context_device))
+
+ if context_model_app is not None:
+
+ _query_params.append(('context_model_app', context_model_app))
+
+ if context_model_name is not None:
+
+ _query_params.append(('context_model_name', context_model_name))
+
+ if context_model_pk is not None:
+
+ _query_params.append(('context_model_pk', context_model_pk))
+
+ if history_days is not None:
+
+ _query_params.append(('history_days', history_days))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if username is not None:
+
+ _query_params.append(('username', username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/events/volume/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """events_notifications_destroy
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """events_notifications_destroy
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_destroy
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/events/notifications/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_list(
+ self,
+ body: Optional[StrictStr] = None,
+ created: Optional[datetime] = None,
+ event: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ seen: Optional[StrictBool] = None,
+ severity: Optional[SeverityEnum] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedNotificationList:
+ """events_notifications_list
+
+ Notification Viewset
+
+ :param body:
+ :type body: str
+ :param created:
+ :type created: datetime
+ :param event:
+ :type event: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param seen:
+ :type seen: bool
+ :param severity:
+ :type severity: SeverityEnum
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_list_serialize(
+ body=body,
+ created=created,
+ event=event,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ seen=seen,
+ severity=severity,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_list_with_http_info(
+ self,
+ body: Optional[StrictStr] = None,
+ created: Optional[datetime] = None,
+ event: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ seen: Optional[StrictBool] = None,
+ severity: Optional[SeverityEnum] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedNotificationList]:
+ """events_notifications_list
+
+ Notification Viewset
+
+ :param body:
+ :type body: str
+ :param created:
+ :type created: datetime
+ :param event:
+ :type event: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param seen:
+ :type seen: bool
+ :param severity:
+ :type severity: SeverityEnum
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_list_serialize(
+ body=body,
+ created=created,
+ event=event,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ seen=seen,
+ severity=severity,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_list_without_preload_content(
+ self,
+ body: Optional[StrictStr] = None,
+ created: Optional[datetime] = None,
+ event: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ seen: Optional[StrictBool] = None,
+ severity: Optional[SeverityEnum] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_list
+
+ Notification Viewset
+
+ :param body:
+ :type body: str
+ :param created:
+ :type created: datetime
+ :param event:
+ :type event: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param seen:
+ :type seen: bool
+ :param severity:
+ :type severity: SeverityEnum
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_list_serialize(
+ body=body,
+ created=created,
+ event=event,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ seen=seen,
+ severity=severity,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_list_serialize(
+ self,
+ body,
+ created,
+ event,
+ ordering,
+ page,
+ page_size,
+ search,
+ seen,
+ severity,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if body is not None:
+
+ _query_params.append(('body', body))
+
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if event is not None:
+
+ _query_params.append(('event', event))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if seen is not None:
+
+ _query_params.append(('seen', seen))
+
+ if severity is not None:
+
+ _query_params.append(('severity', severity.value))
+
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/notifications/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_mark_all_seen_create(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """events_notifications_mark_all_seen_create
+
+ Mark all the user's notifications as seen
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_mark_all_seen_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_mark_all_seen_create_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """events_notifications_mark_all_seen_create
+
+ Mark all the user's notifications as seen
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_mark_all_seen_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_mark_all_seen_create_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_mark_all_seen_create
+
+ Mark all the user's notifications as seen
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_mark_all_seen_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_mark_all_seen_create_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/events/notifications/mark_all_seen/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ patched_notification_request: Optional[PatchedNotificationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Notification:
+ """events_notifications_partial_update
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param patched_notification_request:
+ :type patched_notification_request: PatchedNotificationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_partial_update_serialize(
+ uuid=uuid,
+ patched_notification_request=patched_notification_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ patched_notification_request: Optional[PatchedNotificationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Notification]:
+ """events_notifications_partial_update
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param patched_notification_request:
+ :type patched_notification_request: PatchedNotificationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_partial_update_serialize(
+ uuid=uuid,
+ patched_notification_request=patched_notification_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ patched_notification_request: Optional[PatchedNotificationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_partial_update
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param patched_notification_request:
+ :type patched_notification_request: PatchedNotificationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_partial_update_serialize(
+ uuid=uuid,
+ patched_notification_request=patched_notification_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_partial_update_serialize(
+ self,
+ uuid,
+ patched_notification_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_notification_request is not None:
+ _body_params = patched_notification_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/events/notifications/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Notification:
+ """events_notifications_retrieve
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Notification]:
+ """events_notifications_retrieve
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_retrieve
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/notifications/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ notification_request: Optional[NotificationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Notification:
+ """events_notifications_update
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param notification_request:
+ :type notification_request: NotificationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_update_serialize(
+ uuid=uuid,
+ notification_request=notification_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ notification_request: Optional[NotificationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Notification]:
+ """events_notifications_update
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param notification_request:
+ :type notification_request: NotificationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_update_serialize(
+ uuid=uuid,
+ notification_request=notification_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ notification_request: Optional[NotificationRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_update
+
+ Notification Viewset
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param notification_request:
+ :type notification_request: NotificationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_update_serialize(
+ uuid=uuid,
+ notification_request=notification_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Notification",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_update_serialize(
+ self,
+ uuid,
+ notification_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_request is not None:
+ _body_params = notification_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/events/notifications/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_notifications_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """events_notifications_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_notifications_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """events_notifications_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_notifications_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_notifications_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Notification. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_notifications_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_notifications_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/notifications/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_create(
+ self,
+ notification_rule_request: NotificationRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationRule:
+ """events_rules_create
+
+ NotificationRule Viewset
+
+ :param notification_rule_request: (required)
+ :type notification_rule_request: NotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_create_serialize(
+ notification_rule_request=notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_create_with_http_info(
+ self,
+ notification_rule_request: NotificationRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationRule]:
+ """events_rules_create
+
+ NotificationRule Viewset
+
+ :param notification_rule_request: (required)
+ :type notification_rule_request: NotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_create_serialize(
+ notification_rule_request=notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_create_without_preload_content(
+ self,
+ notification_rule_request: NotificationRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_create
+
+ NotificationRule Viewset
+
+ :param notification_rule_request: (required)
+ :type notification_rule_request: NotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_create_serialize(
+ notification_rule_request=notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_create_serialize(
+ self,
+ notification_rule_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_rule_request is not None:
+ _body_params = notification_rule_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/events/rules/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_destroy(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """events_rules_destroy
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_destroy_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """events_rules_destroy
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_destroy_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_destroy
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_destroy_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/events/rules/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_list(
+ self,
+ destination_group__name: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ severity: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedNotificationRuleList:
+ """events_rules_list
+
+ NotificationRule Viewset
+
+ :param destination_group__name:
+ :type destination_group__name: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param severity:
+ :type severity: SeverityEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_list_serialize(
+ destination_group__name=destination_group__name,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ severity=severity,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationRuleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_list_with_http_info(
+ self,
+ destination_group__name: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ severity: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedNotificationRuleList]:
+ """events_rules_list
+
+ NotificationRule Viewset
+
+ :param destination_group__name:
+ :type destination_group__name: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param severity:
+ :type severity: SeverityEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_list_serialize(
+ destination_group__name=destination_group__name,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ severity=severity,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationRuleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_list_without_preload_content(
+ self,
+ destination_group__name: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ severity: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_list
+
+ NotificationRule Viewset
+
+ :param destination_group__name:
+ :type destination_group__name: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param severity:
+ :type severity: SeverityEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_list_serialize(
+ destination_group__name=destination_group__name,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ severity=severity,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationRuleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_list_serialize(
+ self,
+ destination_group__name,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ severity,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if destination_group__name is not None:
+
+ _query_params.append(('destination_group__name', destination_group__name))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if severity is not None:
+
+ _query_params.append(('severity', severity.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/rules/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_partial_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ patched_notification_rule_request: Optional[PatchedNotificationRuleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationRule:
+ """events_rules_partial_update
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param patched_notification_rule_request:
+ :type patched_notification_rule_request: PatchedNotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_notification_rule_request=patched_notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_partial_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ patched_notification_rule_request: Optional[PatchedNotificationRuleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationRule]:
+ """events_rules_partial_update
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param patched_notification_rule_request:
+ :type patched_notification_rule_request: PatchedNotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_notification_rule_request=patched_notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_partial_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ patched_notification_rule_request: Optional[PatchedNotificationRuleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_partial_update
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param patched_notification_rule_request:
+ :type patched_notification_rule_request: PatchedNotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_notification_rule_request=patched_notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_partial_update_serialize(
+ self,
+ pbm_uuid,
+ patched_notification_rule_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_notification_rule_request is not None:
+ _body_params = patched_notification_rule_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/events/rules/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_retrieve(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationRule:
+ """events_rules_retrieve
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_retrieve_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationRule]:
+ """events_rules_retrieve
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_retrieve_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_retrieve
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_retrieve_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/rules/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ notification_rule_request: NotificationRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationRule:
+ """events_rules_update
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param notification_rule_request: (required)
+ :type notification_rule_request: NotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_update_serialize(
+ pbm_uuid=pbm_uuid,
+ notification_rule_request=notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ notification_rule_request: NotificationRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationRule]:
+ """events_rules_update
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param notification_rule_request: (required)
+ :type notification_rule_request: NotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_update_serialize(
+ pbm_uuid=pbm_uuid,
+ notification_rule_request=notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ notification_rule_request: NotificationRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_update
+
+ NotificationRule Viewset
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param notification_rule_request: (required)
+ :type notification_rule_request: NotificationRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_update_serialize(
+ pbm_uuid=pbm_uuid,
+ notification_rule_request=notification_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_update_serialize(
+ self,
+ pbm_uuid,
+ notification_rule_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_rule_request is not None:
+ _body_params = notification_rule_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/events/rules/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_rules_used_by_list(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """events_rules_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_rules_used_by_list_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """events_rules_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_rules_used_by_list_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_rules_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this Notification Rule. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_rules_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_rules_used_by_list_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/rules/{pbm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_create(
+ self,
+ notification_transport_request: NotificationTransportRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationTransport:
+ """events_transports_create
+
+ NotificationTransport Viewset
+
+ :param notification_transport_request: (required)
+ :type notification_transport_request: NotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_create_serialize(
+ notification_transport_request=notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_create_with_http_info(
+ self,
+ notification_transport_request: NotificationTransportRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationTransport]:
+ """events_transports_create
+
+ NotificationTransport Viewset
+
+ :param notification_transport_request: (required)
+ :type notification_transport_request: NotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_create_serialize(
+ notification_transport_request=notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_create_without_preload_content(
+ self,
+ notification_transport_request: NotificationTransportRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_create
+
+ NotificationTransport Viewset
+
+ :param notification_transport_request: (required)
+ :type notification_transport_request: NotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_create_serialize(
+ notification_transport_request=notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_create_serialize(
+ self,
+ notification_transport_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_transport_request is not None:
+ _body_params = notification_transport_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/events/transports/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """events_transports_destroy
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """events_transports_destroy
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_destroy
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/events/transports/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_list(
+ self,
+ mode: Optional[TransportModeEnum] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ send_once: Optional[StrictBool] = None,
+ webhook_url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedNotificationTransportList:
+ """events_transports_list
+
+ NotificationTransport Viewset
+
+ :param mode:
+ :type mode: TransportModeEnum
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param send_once:
+ :type send_once: bool
+ :param webhook_url:
+ :type webhook_url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_list_serialize(
+ mode=mode,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ send_once=send_once,
+ webhook_url=webhook_url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationTransportList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_list_with_http_info(
+ self,
+ mode: Optional[TransportModeEnum] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ send_once: Optional[StrictBool] = None,
+ webhook_url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedNotificationTransportList]:
+ """events_transports_list
+
+ NotificationTransport Viewset
+
+ :param mode:
+ :type mode: TransportModeEnum
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param send_once:
+ :type send_once: bool
+ :param webhook_url:
+ :type webhook_url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_list_serialize(
+ mode=mode,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ send_once=send_once,
+ webhook_url=webhook_url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationTransportList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_list_without_preload_content(
+ self,
+ mode: Optional[TransportModeEnum] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ send_once: Optional[StrictBool] = None,
+ webhook_url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_list
+
+ NotificationTransport Viewset
+
+ :param mode:
+ :type mode: TransportModeEnum
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param send_once:
+ :type send_once: bool
+ :param webhook_url:
+ :type webhook_url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_list_serialize(
+ mode=mode,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ send_once=send_once,
+ webhook_url=webhook_url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationTransportList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_list_serialize(
+ self,
+ mode,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ send_once,
+ webhook_url,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if mode is not None:
+
+ _query_params.append(('mode', mode.value))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if send_once is not None:
+
+ _query_params.append(('send_once', send_once))
+
+ if webhook_url is not None:
+
+ _query_params.append(('webhook_url', webhook_url))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/transports/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ patched_notification_transport_request: Optional[PatchedNotificationTransportRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationTransport:
+ """events_transports_partial_update
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param patched_notification_transport_request:
+ :type patched_notification_transport_request: PatchedNotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_partial_update_serialize(
+ uuid=uuid,
+ patched_notification_transport_request=patched_notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ patched_notification_transport_request: Optional[PatchedNotificationTransportRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationTransport]:
+ """events_transports_partial_update
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param patched_notification_transport_request:
+ :type patched_notification_transport_request: PatchedNotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_partial_update_serialize(
+ uuid=uuid,
+ patched_notification_transport_request=patched_notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ patched_notification_transport_request: Optional[PatchedNotificationTransportRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_partial_update
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param patched_notification_transport_request:
+ :type patched_notification_transport_request: PatchedNotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_partial_update_serialize(
+ uuid=uuid,
+ patched_notification_transport_request=patched_notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_partial_update_serialize(
+ self,
+ uuid,
+ patched_notification_transport_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_notification_transport_request is not None:
+ _body_params = patched_notification_transport_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/events/transports/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationTransport:
+ """events_transports_retrieve
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationTransport]:
+ """events_transports_retrieve
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_retrieve
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/transports/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_test_create(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationTransportTest:
+ """events_transports_test_create
+
+ Send example notification using selected transport. Requires Modify permissions.
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_test_create_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransportTest",
+ '500': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_test_create_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationTransportTest]:
+ """events_transports_test_create
+
+ Send example notification using selected transport. Requires Modify permissions.
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_test_create_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransportTest",
+ '500': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_test_create_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_test_create
+
+ Send example notification using selected transport. Requires Modify permissions.
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_test_create_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransportTest",
+ '500': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_test_create_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/events/transports/{uuid}/test/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ notification_transport_request: NotificationTransportRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationTransport:
+ """events_transports_update
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param notification_transport_request: (required)
+ :type notification_transport_request: NotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_update_serialize(
+ uuid=uuid,
+ notification_transport_request=notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ notification_transport_request: NotificationTransportRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationTransport]:
+ """events_transports_update
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param notification_transport_request: (required)
+ :type notification_transport_request: NotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_update_serialize(
+ uuid=uuid,
+ notification_transport_request=notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ notification_transport_request: NotificationTransportRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_update
+
+ NotificationTransport Viewset
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param notification_transport_request: (required)
+ :type notification_transport_request: NotificationTransportRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_update_serialize(
+ uuid=uuid,
+ notification_transport_request=notification_transport_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationTransport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_update_serialize(
+ self,
+ uuid,
+ notification_transport_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_transport_request is not None:
+ _body_params = notification_transport_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/events/transports/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def events_transports_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """events_transports_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def events_transports_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """events_transports_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def events_transports_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Notification Transport.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """events_transports_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Notification Transport. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._events_transports_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _events_transports_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/events/transports/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/flows_api.py b/authentik_client/api/flows_api.py
new file mode 100644
index 000000000..d09d45b05
--- /dev/null
+++ b/authentik_client/api/flows_api.py
@@ -0,0 +1,6461 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr
+from typing import Any, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.cache import Cache
+from authentik_client.models.challenge_types import ChallengeTypes
+from authentik_client.models.flow import Flow
+from authentik_client.models.flow_challenge_response_request import FlowChallengeResponseRequest
+from authentik_client.models.flow_diagram import FlowDiagram
+from authentik_client.models.flow_inspection import FlowInspection
+from authentik_client.models.flow_request import FlowRequest
+from authentik_client.models.flow_stage_binding import FlowStageBinding
+from authentik_client.models.flow_stage_binding_request import FlowStageBindingRequest
+from authentik_client.models.link import Link
+from authentik_client.models.paginated_flow_list import PaginatedFlowList
+from authentik_client.models.paginated_flow_stage_binding_list import PaginatedFlowStageBindingList
+from authentik_client.models.patched_flow_request import PatchedFlowRequest
+from authentik_client.models.patched_flow_stage_binding_request import PatchedFlowStageBindingRequest
+from authentik_client.models.policy_engine_mode import PolicyEngineMode
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class FlowsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def flows_bindings_create(
+ self,
+ flow_stage_binding_request: FlowStageBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FlowStageBinding:
+ """flows_bindings_create
+
+ FlowStageBinding Viewset
+
+ :param flow_stage_binding_request: (required)
+ :type flow_stage_binding_request: FlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_create_serialize(
+ flow_stage_binding_request=flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_create_with_http_info(
+ self,
+ flow_stage_binding_request: FlowStageBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FlowStageBinding]:
+ """flows_bindings_create
+
+ FlowStageBinding Viewset
+
+ :param flow_stage_binding_request: (required)
+ :type flow_stage_binding_request: FlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_create_serialize(
+ flow_stage_binding_request=flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_create_without_preload_content(
+ self,
+ flow_stage_binding_request: FlowStageBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_create
+
+ FlowStageBinding Viewset
+
+ :param flow_stage_binding_request: (required)
+ :type flow_stage_binding_request: FlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_create_serialize(
+ flow_stage_binding_request=flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_create_serialize(
+ self,
+ flow_stage_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if flow_stage_binding_request is not None:
+ _body_params = flow_stage_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/flows/bindings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_bindings_destroy(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """flows_bindings_destroy
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_destroy_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_destroy_with_http_info(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """flows_bindings_destroy
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_destroy_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_destroy_without_preload_content(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_destroy
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_destroy_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_destroy_serialize(
+ self,
+ fsb_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if fsb_uuid is not None:
+ _path_params['fsb_uuid'] = fsb_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/flows/bindings/{fsb_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_bindings_list(
+ self,
+ evaluate_on_plan: Optional[StrictBool] = None,
+ fsb_uuid: Optional[UUID] = None,
+ invalid_response_action: Optional[Any] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ policies: Optional[List[UUID]] = None,
+ policy_engine_mode: Optional[PolicyEngineMode] = None,
+ re_evaluate_policies: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ stage: Optional[UUID] = None,
+ target: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedFlowStageBindingList:
+ """flows_bindings_list
+
+ FlowStageBinding Viewset
+
+ :param evaluate_on_plan:
+ :type evaluate_on_plan: bool
+ :param fsb_uuid:
+ :type fsb_uuid: UUID
+ :param invalid_response_action:
+ :type invalid_response_action: InvalidResponseActionEnum
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param policies:
+ :type policies: List[UUID]
+ :param policy_engine_mode:
+ :type policy_engine_mode: PolicyEngineMode
+ :param re_evaluate_policies:
+ :type re_evaluate_policies: bool
+ :param search: A search term.
+ :type search: str
+ :param stage:
+ :type stage: UUID
+ :param target:
+ :type target: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_list_serialize(
+ evaluate_on_plan=evaluate_on_plan,
+ fsb_uuid=fsb_uuid,
+ invalid_response_action=invalid_response_action,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ policies=policies,
+ policy_engine_mode=policy_engine_mode,
+ re_evaluate_policies=re_evaluate_policies,
+ search=search,
+ stage=stage,
+ target=target,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFlowStageBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_list_with_http_info(
+ self,
+ evaluate_on_plan: Optional[StrictBool] = None,
+ fsb_uuid: Optional[UUID] = None,
+ invalid_response_action: Optional[Any] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ policies: Optional[List[UUID]] = None,
+ policy_engine_mode: Optional[PolicyEngineMode] = None,
+ re_evaluate_policies: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ stage: Optional[UUID] = None,
+ target: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedFlowStageBindingList]:
+ """flows_bindings_list
+
+ FlowStageBinding Viewset
+
+ :param evaluate_on_plan:
+ :type evaluate_on_plan: bool
+ :param fsb_uuid:
+ :type fsb_uuid: UUID
+ :param invalid_response_action:
+ :type invalid_response_action: InvalidResponseActionEnum
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param policies:
+ :type policies: List[UUID]
+ :param policy_engine_mode:
+ :type policy_engine_mode: PolicyEngineMode
+ :param re_evaluate_policies:
+ :type re_evaluate_policies: bool
+ :param search: A search term.
+ :type search: str
+ :param stage:
+ :type stage: UUID
+ :param target:
+ :type target: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_list_serialize(
+ evaluate_on_plan=evaluate_on_plan,
+ fsb_uuid=fsb_uuid,
+ invalid_response_action=invalid_response_action,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ policies=policies,
+ policy_engine_mode=policy_engine_mode,
+ re_evaluate_policies=re_evaluate_policies,
+ search=search,
+ stage=stage,
+ target=target,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFlowStageBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_list_without_preload_content(
+ self,
+ evaluate_on_plan: Optional[StrictBool] = None,
+ fsb_uuid: Optional[UUID] = None,
+ invalid_response_action: Optional[Any] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ policies: Optional[List[UUID]] = None,
+ policy_engine_mode: Optional[PolicyEngineMode] = None,
+ re_evaluate_policies: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ stage: Optional[UUID] = None,
+ target: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_list
+
+ FlowStageBinding Viewset
+
+ :param evaluate_on_plan:
+ :type evaluate_on_plan: bool
+ :param fsb_uuid:
+ :type fsb_uuid: UUID
+ :param invalid_response_action:
+ :type invalid_response_action: InvalidResponseActionEnum
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param policies:
+ :type policies: List[UUID]
+ :param policy_engine_mode:
+ :type policy_engine_mode: PolicyEngineMode
+ :param re_evaluate_policies:
+ :type re_evaluate_policies: bool
+ :param search: A search term.
+ :type search: str
+ :param stage:
+ :type stage: UUID
+ :param target:
+ :type target: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_list_serialize(
+ evaluate_on_plan=evaluate_on_plan,
+ fsb_uuid=fsb_uuid,
+ invalid_response_action=invalid_response_action,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ policies=policies,
+ policy_engine_mode=policy_engine_mode,
+ re_evaluate_policies=re_evaluate_policies,
+ search=search,
+ stage=stage,
+ target=target,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFlowStageBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_list_serialize(
+ self,
+ evaluate_on_plan,
+ fsb_uuid,
+ invalid_response_action,
+ order,
+ ordering,
+ page,
+ page_size,
+ pbm_uuid,
+ policies,
+ policy_engine_mode,
+ re_evaluate_policies,
+ search,
+ stage,
+ target,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'policies': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if evaluate_on_plan is not None:
+
+ _query_params.append(('evaluate_on_plan', evaluate_on_plan))
+
+ if fsb_uuid is not None:
+
+ _query_params.append(('fsb_uuid', fsb_uuid))
+
+ if invalid_response_action is not None:
+
+ _query_params.append(('invalid_response_action', invalid_response_action.value))
+
+ if order is not None:
+
+ _query_params.append(('order', order))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if pbm_uuid is not None:
+
+ _query_params.append(('pbm_uuid', pbm_uuid))
+
+ if policies is not None:
+
+ _query_params.append(('policies', policies))
+
+ if policy_engine_mode is not None:
+
+ _query_params.append(('policy_engine_mode', policy_engine_mode.value))
+
+ if re_evaluate_policies is not None:
+
+ _query_params.append(('re_evaluate_policies', re_evaluate_policies))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if stage is not None:
+
+ _query_params.append(('stage', stage))
+
+ if target is not None:
+
+ _query_params.append(('target', target))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/bindings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_bindings_partial_update(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ patched_flow_stage_binding_request: Optional[PatchedFlowStageBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FlowStageBinding:
+ """flows_bindings_partial_update
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param patched_flow_stage_binding_request:
+ :type patched_flow_stage_binding_request: PatchedFlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_partial_update_serialize(
+ fsb_uuid=fsb_uuid,
+ patched_flow_stage_binding_request=patched_flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_partial_update_with_http_info(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ patched_flow_stage_binding_request: Optional[PatchedFlowStageBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FlowStageBinding]:
+ """flows_bindings_partial_update
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param patched_flow_stage_binding_request:
+ :type patched_flow_stage_binding_request: PatchedFlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_partial_update_serialize(
+ fsb_uuid=fsb_uuid,
+ patched_flow_stage_binding_request=patched_flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_partial_update_without_preload_content(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ patched_flow_stage_binding_request: Optional[PatchedFlowStageBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_partial_update
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param patched_flow_stage_binding_request:
+ :type patched_flow_stage_binding_request: PatchedFlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_partial_update_serialize(
+ fsb_uuid=fsb_uuid,
+ patched_flow_stage_binding_request=patched_flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_partial_update_serialize(
+ self,
+ fsb_uuid,
+ patched_flow_stage_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if fsb_uuid is not None:
+ _path_params['fsb_uuid'] = fsb_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_flow_stage_binding_request is not None:
+ _body_params = patched_flow_stage_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/flows/bindings/{fsb_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_bindings_retrieve(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FlowStageBinding:
+ """flows_bindings_retrieve
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_retrieve_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_retrieve_with_http_info(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FlowStageBinding]:
+ """flows_bindings_retrieve
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_retrieve_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_retrieve_without_preload_content(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_retrieve
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_retrieve_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_retrieve_serialize(
+ self,
+ fsb_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if fsb_uuid is not None:
+ _path_params['fsb_uuid'] = fsb_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/bindings/{fsb_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_bindings_update(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ flow_stage_binding_request: FlowStageBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FlowStageBinding:
+ """flows_bindings_update
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param flow_stage_binding_request: (required)
+ :type flow_stage_binding_request: FlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_update_serialize(
+ fsb_uuid=fsb_uuid,
+ flow_stage_binding_request=flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_update_with_http_info(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ flow_stage_binding_request: FlowStageBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FlowStageBinding]:
+ """flows_bindings_update
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param flow_stage_binding_request: (required)
+ :type flow_stage_binding_request: FlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_update_serialize(
+ fsb_uuid=fsb_uuid,
+ flow_stage_binding_request=flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_update_without_preload_content(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ flow_stage_binding_request: FlowStageBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_update
+
+ FlowStageBinding Viewset
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param flow_stage_binding_request: (required)
+ :type flow_stage_binding_request: FlowStageBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_update_serialize(
+ fsb_uuid=fsb_uuid,
+ flow_stage_binding_request=flow_stage_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowStageBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_update_serialize(
+ self,
+ fsb_uuid,
+ flow_stage_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if fsb_uuid is not None:
+ _path_params['fsb_uuid'] = fsb_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if flow_stage_binding_request is not None:
+ _body_params = flow_stage_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/flows/bindings/{fsb_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_bindings_used_by_list(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """flows_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_used_by_list_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_bindings_used_by_list_with_http_info(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """flows_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_used_by_list_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_bindings_used_by_list_without_preload_content(
+ self,
+ fsb_uuid: Annotated[UUID, Field(description="A UUID string identifying this Flow Stage Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param fsb_uuid: A UUID string identifying this Flow Stage Binding. (required)
+ :type fsb_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_bindings_used_by_list_serialize(
+ fsb_uuid=fsb_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_bindings_used_by_list_serialize(
+ self,
+ fsb_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if fsb_uuid is not None:
+ _path_params['fsb_uuid'] = fsb_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/bindings/{fsb_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_executor_get(
+ self,
+ flow_slug: StrictStr,
+ query: Annotated[StrictStr, Field(description="Querystring as received")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ChallengeTypes:
+ """flows_executor_get
+
+ Get the next pending challenge from the currently active flow.
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param query: Querystring as received (required)
+ :type query: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_executor_get_serialize(
+ flow_slug=flow_slug,
+ query=query,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ChallengeTypes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_executor_get_with_http_info(
+ self,
+ flow_slug: StrictStr,
+ query: Annotated[StrictStr, Field(description="Querystring as received")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ChallengeTypes]:
+ """flows_executor_get
+
+ Get the next pending challenge from the currently active flow.
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param query: Querystring as received (required)
+ :type query: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_executor_get_serialize(
+ flow_slug=flow_slug,
+ query=query,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ChallengeTypes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_executor_get_without_preload_content(
+ self,
+ flow_slug: StrictStr,
+ query: Annotated[StrictStr, Field(description="Querystring as received")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_executor_get
+
+ Get the next pending challenge from the currently active flow.
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param query: Querystring as received (required)
+ :type query: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_executor_get_serialize(
+ flow_slug=flow_slug,
+ query=query,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ChallengeTypes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_executor_get_serialize(
+ self,
+ flow_slug,
+ query,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if flow_slug is not None:
+ _path_params['flow_slug'] = flow_slug
+ # process the query parameters
+ if query is not None:
+
+ _query_params.append(('query', query))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/executor/{flow_slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_executor_solve(
+ self,
+ flow_slug: StrictStr,
+ query: Annotated[StrictStr, Field(description="Querystring as received")],
+ flow_challenge_response_request: Optional[FlowChallengeResponseRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ChallengeTypes:
+ """flows_executor_solve
+
+ Solve the previously retrieved challenge and advanced to the next stage.
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param query: Querystring as received (required)
+ :type query: str
+ :param flow_challenge_response_request:
+ :type flow_challenge_response_request: FlowChallengeResponseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_executor_solve_serialize(
+ flow_slug=flow_slug,
+ query=query,
+ flow_challenge_response_request=flow_challenge_response_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ChallengeTypes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_executor_solve_with_http_info(
+ self,
+ flow_slug: StrictStr,
+ query: Annotated[StrictStr, Field(description="Querystring as received")],
+ flow_challenge_response_request: Optional[FlowChallengeResponseRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ChallengeTypes]:
+ """flows_executor_solve
+
+ Solve the previously retrieved challenge and advanced to the next stage.
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param query: Querystring as received (required)
+ :type query: str
+ :param flow_challenge_response_request:
+ :type flow_challenge_response_request: FlowChallengeResponseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_executor_solve_serialize(
+ flow_slug=flow_slug,
+ query=query,
+ flow_challenge_response_request=flow_challenge_response_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ChallengeTypes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_executor_solve_without_preload_content(
+ self,
+ flow_slug: StrictStr,
+ query: Annotated[StrictStr, Field(description="Querystring as received")],
+ flow_challenge_response_request: Optional[FlowChallengeResponseRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_executor_solve
+
+ Solve the previously retrieved challenge and advanced to the next stage.
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param query: Querystring as received (required)
+ :type query: str
+ :param flow_challenge_response_request:
+ :type flow_challenge_response_request: FlowChallengeResponseRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_executor_solve_serialize(
+ flow_slug=flow_slug,
+ query=query,
+ flow_challenge_response_request=flow_challenge_response_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ChallengeTypes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_executor_solve_serialize(
+ self,
+ flow_slug,
+ query,
+ flow_challenge_response_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if flow_slug is not None:
+ _path_params['flow_slug'] = flow_slug
+ # process the query parameters
+ if query is not None:
+
+ _query_params.append(('query', query))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if flow_challenge_response_request is not None:
+ _body_params = flow_challenge_response_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/flows/executor/{flow_slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_inspector_get(
+ self,
+ flow_slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FlowInspection:
+ """flows_inspector_get
+
+ Get current flow state and record it
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_inspector_get_serialize(
+ flow_slug=flow_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowInspection",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_inspector_get_with_http_info(
+ self,
+ flow_slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FlowInspection]:
+ """flows_inspector_get
+
+ Get current flow state and record it
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_inspector_get_serialize(
+ flow_slug=flow_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowInspection",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_inspector_get_without_preload_content(
+ self,
+ flow_slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_inspector_get
+
+ Get current flow state and record it
+
+ :param flow_slug: (required)
+ :type flow_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_inspector_get_serialize(
+ flow_slug=flow_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowInspection",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_inspector_get_serialize(
+ self,
+ flow_slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if flow_slug is not None:
+ _path_params['flow_slug'] = flow_slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/inspector/{flow_slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_cache_clear_create(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """flows_instances_cache_clear_create
+
+ Clear flow cache
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_cache_clear_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_cache_clear_create_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """flows_instances_cache_clear_create
+
+ Clear flow cache
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_cache_clear_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_cache_clear_create_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_cache_clear_create
+
+ Clear flow cache
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_cache_clear_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_cache_clear_create_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/flows/instances/cache_clear/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_cache_info_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Cache:
+ """flows_instances_cache_info_retrieve
+
+ Info about cached flows
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_cache_info_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Cache",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_cache_info_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Cache]:
+ """flows_instances_cache_info_retrieve
+
+ Info about cached flows
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_cache_info_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Cache",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_cache_info_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_cache_info_retrieve
+
+ Info about cached flows
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_cache_info_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Cache",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_cache_info_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/cache_info/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_create(
+ self,
+ flow_request: FlowRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Flow:
+ """flows_instances_create
+
+ Flow Viewset
+
+ :param flow_request: (required)
+ :type flow_request: FlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_create_serialize(
+ flow_request=flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_create_with_http_info(
+ self,
+ flow_request: FlowRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Flow]:
+ """flows_instances_create
+
+ Flow Viewset
+
+ :param flow_request: (required)
+ :type flow_request: FlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_create_serialize(
+ flow_request=flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_create_without_preload_content(
+ self,
+ flow_request: FlowRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_create
+
+ Flow Viewset
+
+ :param flow_request: (required)
+ :type flow_request: FlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_create_serialize(
+ flow_request=flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_create_serialize(
+ self,
+ flow_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if flow_request is not None:
+ _body_params = flow_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/flows/instances/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_destroy(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """flows_instances_destroy
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_destroy_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """flows_instances_destroy
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_destroy_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_destroy
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_destroy_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/flows/instances/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_diagram_retrieve(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> FlowDiagram:
+ """flows_instances_diagram_retrieve
+
+ Return diagram for flow with slug `slug`, in the format used by flowchart.js
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_diagram_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowDiagram",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_diagram_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[FlowDiagram]:
+ """flows_instances_diagram_retrieve
+
+ Return diagram for flow with slug `slug`, in the format used by flowchart.js
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_diagram_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowDiagram",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_diagram_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_diagram_retrieve
+
+ Return diagram for flow with slug `slug`, in the format used by flowchart.js
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_diagram_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "FlowDiagram",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_diagram_retrieve_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/{slug}/diagram/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_execute_retrieve(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Link:
+ """flows_instances_execute_retrieve
+
+ Execute flow for current user
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_execute_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_execute_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Link]:
+ """flows_instances_execute_retrieve
+
+ Execute flow for current user
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_execute_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_execute_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_execute_retrieve
+
+ Execute flow for current user
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_execute_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Link",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_execute_retrieve_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/{slug}/execute/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_export_retrieve(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> bytes:
+ """flows_instances_export_retrieve
+
+ Export flow to .yaml file
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_export_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "bytes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_export_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[bytes]:
+ """flows_instances_export_retrieve
+
+ Export flow to .yaml file
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_export_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "bytes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_export_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_export_retrieve
+
+ Export flow to .yaml file
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_export_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "bytes",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_export_retrieve_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/{slug}/export/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_list(
+ self,
+ denied_action: Optional[Any] = None,
+ designation: Optional[Any] = None,
+ flow_uuid: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedFlowList:
+ """flows_instances_list
+
+ Flow Viewset
+
+ :param denied_action:
+ :type denied_action: DeniedActionEnum
+ :param designation:
+ :type designation: FlowDesignationEnum
+ :param flow_uuid:
+ :type flow_uuid: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_list_serialize(
+ denied_action=denied_action,
+ designation=designation,
+ flow_uuid=flow_uuid,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFlowList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_list_with_http_info(
+ self,
+ denied_action: Optional[Any] = None,
+ designation: Optional[Any] = None,
+ flow_uuid: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedFlowList]:
+ """flows_instances_list
+
+ Flow Viewset
+
+ :param denied_action:
+ :type denied_action: DeniedActionEnum
+ :param designation:
+ :type designation: FlowDesignationEnum
+ :param flow_uuid:
+ :type flow_uuid: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_list_serialize(
+ denied_action=denied_action,
+ designation=designation,
+ flow_uuid=flow_uuid,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFlowList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_list_without_preload_content(
+ self,
+ denied_action: Optional[Any] = None,
+ designation: Optional[Any] = None,
+ flow_uuid: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_list
+
+ Flow Viewset
+
+ :param denied_action:
+ :type denied_action: DeniedActionEnum
+ :param designation:
+ :type designation: FlowDesignationEnum
+ :param flow_uuid:
+ :type flow_uuid: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_list_serialize(
+ denied_action=denied_action,
+ designation=designation,
+ flow_uuid=flow_uuid,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedFlowList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_list_serialize(
+ self,
+ denied_action,
+ designation,
+ flow_uuid,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if denied_action is not None:
+
+ _query_params.append(('denied_action', denied_action.value))
+
+ if designation is not None:
+
+ _query_params.append(('designation', designation.value))
+
+ if flow_uuid is not None:
+
+ _query_params.append(('flow_uuid', flow_uuid))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if slug is not None:
+
+ _query_params.append(('slug', slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_partial_update(
+ self,
+ slug: StrictStr,
+ patched_flow_request: Optional[PatchedFlowRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Flow:
+ """flows_instances_partial_update
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param patched_flow_request:
+ :type patched_flow_request: PatchedFlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_partial_update_serialize(
+ slug=slug,
+ patched_flow_request=patched_flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_partial_update_with_http_info(
+ self,
+ slug: StrictStr,
+ patched_flow_request: Optional[PatchedFlowRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Flow]:
+ """flows_instances_partial_update
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param patched_flow_request:
+ :type patched_flow_request: PatchedFlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_partial_update_serialize(
+ slug=slug,
+ patched_flow_request=patched_flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_partial_update_without_preload_content(
+ self,
+ slug: StrictStr,
+ patched_flow_request: Optional[PatchedFlowRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_partial_update
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param patched_flow_request:
+ :type patched_flow_request: PatchedFlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_partial_update_serialize(
+ slug=slug,
+ patched_flow_request=patched_flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_partial_update_serialize(
+ self,
+ slug,
+ patched_flow_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_flow_request is not None:
+ _body_params = patched_flow_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/flows/instances/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_retrieve(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Flow:
+ """flows_instances_retrieve
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Flow]:
+ """flows_instances_retrieve
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_retrieve
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_retrieve_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_update(
+ self,
+ slug: StrictStr,
+ flow_request: FlowRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Flow:
+ """flows_instances_update
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param flow_request: (required)
+ :type flow_request: FlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_update_serialize(
+ slug=slug,
+ flow_request=flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_update_with_http_info(
+ self,
+ slug: StrictStr,
+ flow_request: FlowRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Flow]:
+ """flows_instances_update
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param flow_request: (required)
+ :type flow_request: FlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_update_serialize(
+ slug=slug,
+ flow_request=flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_update_without_preload_content(
+ self,
+ slug: StrictStr,
+ flow_request: FlowRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_update
+
+ Flow Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param flow_request: (required)
+ :type flow_request: FlowRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_update_serialize(
+ slug=slug,
+ flow_request=flow_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Flow",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_update_serialize(
+ self,
+ slug,
+ flow_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if flow_request is not None:
+ _body_params = flow_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/flows/instances/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def flows_instances_used_by_list(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """flows_instances_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def flows_instances_used_by_list_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """flows_instances_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def flows_instances_used_by_list_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """flows_instances_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._flows_instances_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _flows_instances_used_by_list_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/flows/instances/{slug}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/lifecycle_api.py b/authentik_client/api/lifecycle_api.py
new file mode 100644
index 000000000..ef916e9d9
--- /dev/null
+++ b/authentik_client/api/lifecycle_api.py
@@ -0,0 +1,3001 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.lifecycle_iteration import LifecycleIteration
+from authentik_client.models.lifecycle_iteration_request import LifecycleIterationRequest
+from authentik_client.models.lifecycle_rule import LifecycleRule
+from authentik_client.models.lifecycle_rule_request import LifecycleRuleRequest
+from authentik_client.models.paginated_lifecycle_iteration_list import PaginatedLifecycleIterationList
+from authentik_client.models.paginated_lifecycle_rule_list import PaginatedLifecycleRuleList
+from authentik_client.models.patched_lifecycle_rule_request import PatchedLifecycleRuleRequest
+from authentik_client.models.review import Review
+from authentik_client.models.review_request import ReviewRequest
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class LifecycleApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def lifecycle_iterations_create(
+ self,
+ lifecycle_iteration_request: LifecycleIterationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LifecycleIteration:
+ """lifecycle_iterations_create
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param lifecycle_iteration_request: (required)
+ :type lifecycle_iteration_request: LifecycleIterationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_create_serialize(
+ lifecycle_iteration_request=lifecycle_iteration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LifecycleIteration",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_iterations_create_with_http_info(
+ self,
+ lifecycle_iteration_request: LifecycleIterationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LifecycleIteration]:
+ """lifecycle_iterations_create
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param lifecycle_iteration_request: (required)
+ :type lifecycle_iteration_request: LifecycleIterationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_create_serialize(
+ lifecycle_iteration_request=lifecycle_iteration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LifecycleIteration",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_iterations_create_without_preload_content(
+ self,
+ lifecycle_iteration_request: LifecycleIterationRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_iterations_create
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param lifecycle_iteration_request: (required)
+ :type lifecycle_iteration_request: LifecycleIterationRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_create_serialize(
+ lifecycle_iteration_request=lifecycle_iteration_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LifecycleIteration",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_iterations_create_serialize(
+ self,
+ lifecycle_iteration_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if lifecycle_iteration_request is not None:
+ _body_params = lifecycle_iteration_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/lifecycle/iterations/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_iterations_list_latest(
+ self,
+ content_type: Annotated[str, Field(strict=True)],
+ object_id: Annotated[str, Field(strict=True)],
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user_is_reviewer: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[LifecycleIteration]:
+ """lifecycle_iterations_list_latest
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param content_type: (required)
+ :type content_type: str
+ :param object_id: (required)
+ :type object_id: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param user_is_reviewer:
+ :type user_is_reviewer: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_list_latest_serialize(
+ content_type=content_type,
+ object_id=object_id,
+ ordering=ordering,
+ search=search,
+ user_is_reviewer=user_is_reviewer,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[LifecycleIteration]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_iterations_list_latest_with_http_info(
+ self,
+ content_type: Annotated[str, Field(strict=True)],
+ object_id: Annotated[str, Field(strict=True)],
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user_is_reviewer: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[LifecycleIteration]]:
+ """lifecycle_iterations_list_latest
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param content_type: (required)
+ :type content_type: str
+ :param object_id: (required)
+ :type object_id: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param user_is_reviewer:
+ :type user_is_reviewer: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_list_latest_serialize(
+ content_type=content_type,
+ object_id=object_id,
+ ordering=ordering,
+ search=search,
+ user_is_reviewer=user_is_reviewer,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[LifecycleIteration]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_iterations_list_latest_without_preload_content(
+ self,
+ content_type: Annotated[str, Field(strict=True)],
+ object_id: Annotated[str, Field(strict=True)],
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user_is_reviewer: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_iterations_list_latest
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param content_type: (required)
+ :type content_type: str
+ :param object_id: (required)
+ :type object_id: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param search: A search term.
+ :type search: str
+ :param user_is_reviewer:
+ :type user_is_reviewer: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_list_latest_serialize(
+ content_type=content_type,
+ object_id=object_id,
+ ordering=ordering,
+ search=search,
+ user_is_reviewer=user_is_reviewer,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[LifecycleIteration]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_iterations_list_latest_serialize(
+ self,
+ content_type,
+ object_id,
+ ordering,
+ search,
+ user_is_reviewer,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if content_type is not None:
+ _path_params['content_type'] = content_type
+ if object_id is not None:
+ _path_params['object_id'] = object_id
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user_is_reviewer is not None:
+
+ _query_params.append(('user_is_reviewer', user_is_reviewer))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/lifecycle/iterations/latest/{content_type}/{object_id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_iterations_list_open(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user_is_reviewer: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedLifecycleIterationList:
+ """lifecycle_iterations_list_open
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user_is_reviewer:
+ :type user_is_reviewer: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_list_open_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user_is_reviewer=user_is_reviewer,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLifecycleIterationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_iterations_list_open_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user_is_reviewer: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedLifecycleIterationList]:
+ """lifecycle_iterations_list_open
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user_is_reviewer:
+ :type user_is_reviewer: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_list_open_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user_is_reviewer=user_is_reviewer,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLifecycleIterationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_iterations_list_open_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user_is_reviewer: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_iterations_list_open
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param user_is_reviewer:
+ :type user_is_reviewer: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_iterations_list_open_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ user_is_reviewer=user_is_reviewer,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLifecycleIterationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_iterations_list_open_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ search,
+ user_is_reviewer,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user_is_reviewer is not None:
+
+ _query_params.append(('user_is_reviewer', user_is_reviewer))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/lifecycle/iterations/open/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_reviews_create(
+ self,
+ review_request: ReviewRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Review:
+ """lifecycle_reviews_create
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param review_request: (required)
+ :type review_request: ReviewRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_reviews_create_serialize(
+ review_request=review_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Review",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_reviews_create_with_http_info(
+ self,
+ review_request: ReviewRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Review]:
+ """lifecycle_reviews_create
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param review_request: (required)
+ :type review_request: ReviewRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_reviews_create_serialize(
+ review_request=review_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Review",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_reviews_create_without_preload_content(
+ self,
+ review_request: ReviewRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_reviews_create
+
+ Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+ :param review_request: (required)
+ :type review_request: ReviewRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_reviews_create_serialize(
+ review_request=review_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Review",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_reviews_create_serialize(
+ self,
+ review_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if review_request is not None:
+ _body_params = review_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/lifecycle/reviews/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_rules_create(
+ self,
+ lifecycle_rule_request: LifecycleRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LifecycleRule:
+ """lifecycle_rules_create
+
+
+ :param lifecycle_rule_request: (required)
+ :type lifecycle_rule_request: LifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_create_serialize(
+ lifecycle_rule_request=lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_rules_create_with_http_info(
+ self,
+ lifecycle_rule_request: LifecycleRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LifecycleRule]:
+ """lifecycle_rules_create
+
+
+ :param lifecycle_rule_request: (required)
+ :type lifecycle_rule_request: LifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_create_serialize(
+ lifecycle_rule_request=lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_rules_create_without_preload_content(
+ self,
+ lifecycle_rule_request: LifecycleRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_rules_create
+
+
+ :param lifecycle_rule_request: (required)
+ :type lifecycle_rule_request: LifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_create_serialize(
+ lifecycle_rule_request=lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_rules_create_serialize(
+ self,
+ lifecycle_rule_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if lifecycle_rule_request is not None:
+ _body_params = lifecycle_rule_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/lifecycle/rules/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_rules_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """lifecycle_rules_destroy
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_rules_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """lifecycle_rules_destroy
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_rules_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_rules_destroy
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_rules_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/lifecycle/rules/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_rules_list(
+ self,
+ content_type__model: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedLifecycleRuleList:
+ """lifecycle_rules_list
+
+
+ :param content_type__model:
+ :type content_type__model: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_list_serialize(
+ content_type__model=content_type__model,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLifecycleRuleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_rules_list_with_http_info(
+ self,
+ content_type__model: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedLifecycleRuleList]:
+ """lifecycle_rules_list
+
+
+ :param content_type__model:
+ :type content_type__model: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_list_serialize(
+ content_type__model=content_type__model,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLifecycleRuleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_rules_list_without_preload_content(
+ self,
+ content_type__model: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_rules_list
+
+
+ :param content_type__model:
+ :type content_type__model: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_list_serialize(
+ content_type__model=content_type__model,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLifecycleRuleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_rules_list_serialize(
+ self,
+ content_type__model,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if content_type__model is not None:
+
+ _query_params.append(('content_type__model', content_type__model))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/lifecycle/rules/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_rules_partial_update(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ patched_lifecycle_rule_request: Optional[PatchedLifecycleRuleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LifecycleRule:
+ """lifecycle_rules_partial_update
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param patched_lifecycle_rule_request:
+ :type patched_lifecycle_rule_request: PatchedLifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_partial_update_serialize(
+ id=id,
+ patched_lifecycle_rule_request=patched_lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_rules_partial_update_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ patched_lifecycle_rule_request: Optional[PatchedLifecycleRuleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LifecycleRule]:
+ """lifecycle_rules_partial_update
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param patched_lifecycle_rule_request:
+ :type patched_lifecycle_rule_request: PatchedLifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_partial_update_serialize(
+ id=id,
+ patched_lifecycle_rule_request=patched_lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_rules_partial_update_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ patched_lifecycle_rule_request: Optional[PatchedLifecycleRuleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_rules_partial_update
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param patched_lifecycle_rule_request:
+ :type patched_lifecycle_rule_request: PatchedLifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_partial_update_serialize(
+ id=id,
+ patched_lifecycle_rule_request=patched_lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_rules_partial_update_serialize(
+ self,
+ id,
+ patched_lifecycle_rule_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_lifecycle_rule_request is not None:
+ _body_params = patched_lifecycle_rule_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/lifecycle/rules/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_rules_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LifecycleRule:
+ """lifecycle_rules_retrieve
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_rules_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LifecycleRule]:
+ """lifecycle_rules_retrieve
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_rules_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_rules_retrieve
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_rules_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/lifecycle/rules/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def lifecycle_rules_update(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ lifecycle_rule_request: LifecycleRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LifecycleRule:
+ """lifecycle_rules_update
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param lifecycle_rule_request: (required)
+ :type lifecycle_rule_request: LifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_update_serialize(
+ id=id,
+ lifecycle_rule_request=lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def lifecycle_rules_update_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ lifecycle_rule_request: LifecycleRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LifecycleRule]:
+ """lifecycle_rules_update
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param lifecycle_rule_request: (required)
+ :type lifecycle_rule_request: LifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_update_serialize(
+ id=id,
+ lifecycle_rule_request=lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def lifecycle_rules_update_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this lifecycle rule.")],
+ lifecycle_rule_request: LifecycleRuleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """lifecycle_rules_update
+
+
+ :param id: A UUID string identifying this lifecycle rule. (required)
+ :type id: UUID
+ :param lifecycle_rule_request: (required)
+ :type lifecycle_rule_request: LifecycleRuleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._lifecycle_rules_update_serialize(
+ id=id,
+ lifecycle_rule_request=lifecycle_rule_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LifecycleRule",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _lifecycle_rules_update_serialize(
+ self,
+ id,
+ lifecycle_rule_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if lifecycle_rule_request is not None:
+ _body_params = lifecycle_rule_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/lifecycle/rules/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/managed_api.py b/authentik_client/api/managed_api.py
new file mode 100644
index 000000000..f9e35d752
--- /dev/null
+++ b/authentik_client/api/managed_api.py
@@ -0,0 +1,2900 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBytes, StrictInt, StrictStr
+from typing import List, Optional, Tuple, Union
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.blueprint_file import BlueprintFile
+from authentik_client.models.blueprint_import_result import BlueprintImportResult
+from authentik_client.models.blueprint_instance import BlueprintInstance
+from authentik_client.models.blueprint_instance_request import BlueprintInstanceRequest
+from authentik_client.models.paginated_blueprint_instance_list import PaginatedBlueprintInstanceList
+from authentik_client.models.patched_blueprint_instance_request import PatchedBlueprintInstanceRequest
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class ManagedApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def managed_blueprints_apply_create(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BlueprintInstance:
+ """managed_blueprints_apply_create
+
+ Apply a blueprint
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_apply_create_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_apply_create_with_http_info(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BlueprintInstance]:
+ """managed_blueprints_apply_create
+
+ Apply a blueprint
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_apply_create_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_apply_create_without_preload_content(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_apply_create
+
+ Apply a blueprint
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_apply_create_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_apply_create_serialize(
+ self,
+ instance_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if instance_uuid is not None:
+ _path_params['instance_uuid'] = instance_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/managed/blueprints/{instance_uuid}/apply/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_available_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[BlueprintFile]:
+ """managed_blueprints_available_list
+
+ Get blueprints
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_available_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[BlueprintFile]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_available_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[BlueprintFile]]:
+ """managed_blueprints_available_list
+
+ Get blueprints
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_available_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[BlueprintFile]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_available_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_available_list
+
+ Get blueprints
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_available_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[BlueprintFile]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_available_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/managed/blueprints/available/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_create(
+ self,
+ blueprint_instance_request: BlueprintInstanceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BlueprintInstance:
+ """managed_blueprints_create
+
+ Blueprint instances
+
+ :param blueprint_instance_request: (required)
+ :type blueprint_instance_request: BlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_create_serialize(
+ blueprint_instance_request=blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_create_with_http_info(
+ self,
+ blueprint_instance_request: BlueprintInstanceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BlueprintInstance]:
+ """managed_blueprints_create
+
+ Blueprint instances
+
+ :param blueprint_instance_request: (required)
+ :type blueprint_instance_request: BlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_create_serialize(
+ blueprint_instance_request=blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_create_without_preload_content(
+ self,
+ blueprint_instance_request: BlueprintInstanceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_create
+
+ Blueprint instances
+
+ :param blueprint_instance_request: (required)
+ :type blueprint_instance_request: BlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_create_serialize(
+ blueprint_instance_request=blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_create_serialize(
+ self,
+ blueprint_instance_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if blueprint_instance_request is not None:
+ _body_params = blueprint_instance_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/managed/blueprints/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_destroy(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """managed_blueprints_destroy
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_destroy_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_destroy_with_http_info(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """managed_blueprints_destroy
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_destroy_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_destroy_without_preload_content(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_destroy
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_destroy_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_destroy_serialize(
+ self,
+ instance_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if instance_uuid is not None:
+ _path_params['instance_uuid'] = instance_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/managed/blueprints/{instance_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_import_create(
+ self,
+ file: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
+ path: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None,
+ context: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BlueprintImportResult:
+ """managed_blueprints_import_create
+
+ Import blueprint from .yaml file and apply it once, without creating an instance
+
+ :param file:
+ :type file: bytes
+ :param path:
+ :type path: str
+ :param context:
+ :type context: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_import_create_serialize(
+ file=file,
+ path=path,
+ context=context,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintImportResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_import_create_with_http_info(
+ self,
+ file: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
+ path: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None,
+ context: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BlueprintImportResult]:
+ """managed_blueprints_import_create
+
+ Import blueprint from .yaml file and apply it once, without creating an instance
+
+ :param file:
+ :type file: bytes
+ :param path:
+ :type path: str
+ :param context:
+ :type context: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_import_create_serialize(
+ file=file,
+ path=path,
+ context=context,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintImportResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_import_create_without_preload_content(
+ self,
+ file: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
+ path: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None,
+ context: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_import_create
+
+ Import blueprint from .yaml file and apply it once, without creating an instance
+
+ :param file:
+ :type file: bytes
+ :param path:
+ :type path: str
+ :param context:
+ :type context: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_import_create_serialize(
+ file=file,
+ path=path,
+ context=context,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintImportResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_import_create_serialize(
+ self,
+ file,
+ path,
+ context,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ if file is not None:
+ _files['file'] = file
+ if path is not None:
+ _form_params.append(('path', path))
+ if context is not None:
+ _form_params.append(('context', context))
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'multipart/form-data'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/managed/blueprints/import/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ path: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedBlueprintInstanceList:
+ """managed_blueprints_list
+
+ Blueprint instances
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param path:
+ :type path: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ path=path,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedBlueprintInstanceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ path: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedBlueprintInstanceList]:
+ """managed_blueprints_list
+
+ Blueprint instances
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param path:
+ :type path: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ path=path,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedBlueprintInstanceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ path: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_list
+
+ Blueprint instances
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param path:
+ :type path: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ path=path,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedBlueprintInstanceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ path,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if path is not None:
+
+ _query_params.append(('path', path))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/managed/blueprints/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_partial_update(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ patched_blueprint_instance_request: Optional[PatchedBlueprintInstanceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BlueprintInstance:
+ """managed_blueprints_partial_update
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param patched_blueprint_instance_request:
+ :type patched_blueprint_instance_request: PatchedBlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_partial_update_serialize(
+ instance_uuid=instance_uuid,
+ patched_blueprint_instance_request=patched_blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_partial_update_with_http_info(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ patched_blueprint_instance_request: Optional[PatchedBlueprintInstanceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BlueprintInstance]:
+ """managed_blueprints_partial_update
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param patched_blueprint_instance_request:
+ :type patched_blueprint_instance_request: PatchedBlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_partial_update_serialize(
+ instance_uuid=instance_uuid,
+ patched_blueprint_instance_request=patched_blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_partial_update_without_preload_content(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ patched_blueprint_instance_request: Optional[PatchedBlueprintInstanceRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_partial_update
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param patched_blueprint_instance_request:
+ :type patched_blueprint_instance_request: PatchedBlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_partial_update_serialize(
+ instance_uuid=instance_uuid,
+ patched_blueprint_instance_request=patched_blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_partial_update_serialize(
+ self,
+ instance_uuid,
+ patched_blueprint_instance_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if instance_uuid is not None:
+ _path_params['instance_uuid'] = instance_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_blueprint_instance_request is not None:
+ _body_params = patched_blueprint_instance_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/managed/blueprints/{instance_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_retrieve(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BlueprintInstance:
+ """managed_blueprints_retrieve
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_retrieve_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_retrieve_with_http_info(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BlueprintInstance]:
+ """managed_blueprints_retrieve
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_retrieve_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_retrieve_without_preload_content(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_retrieve
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_retrieve_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_retrieve_serialize(
+ self,
+ instance_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if instance_uuid is not None:
+ _path_params['instance_uuid'] = instance_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/managed/blueprints/{instance_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_update(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ blueprint_instance_request: BlueprintInstanceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> BlueprintInstance:
+ """managed_blueprints_update
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param blueprint_instance_request: (required)
+ :type blueprint_instance_request: BlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_update_serialize(
+ instance_uuid=instance_uuid,
+ blueprint_instance_request=blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_update_with_http_info(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ blueprint_instance_request: BlueprintInstanceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[BlueprintInstance]:
+ """managed_blueprints_update
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param blueprint_instance_request: (required)
+ :type blueprint_instance_request: BlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_update_serialize(
+ instance_uuid=instance_uuid,
+ blueprint_instance_request=blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_update_without_preload_content(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ blueprint_instance_request: BlueprintInstanceRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_update
+
+ Blueprint instances
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param blueprint_instance_request: (required)
+ :type blueprint_instance_request: BlueprintInstanceRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_update_serialize(
+ instance_uuid=instance_uuid,
+ blueprint_instance_request=blueprint_instance_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "BlueprintInstance",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_update_serialize(
+ self,
+ instance_uuid,
+ blueprint_instance_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if instance_uuid is not None:
+ _path_params['instance_uuid'] = instance_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if blueprint_instance_request is not None:
+ _body_params = blueprint_instance_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/managed/blueprints/{instance_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def managed_blueprints_used_by_list(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """managed_blueprints_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_used_by_list_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def managed_blueprints_used_by_list_with_http_info(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """managed_blueprints_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_used_by_list_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def managed_blueprints_used_by_list_without_preload_content(
+ self,
+ instance_uuid: Annotated[UUID, Field(description="A UUID string identifying this Blueprint Instance.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """managed_blueprints_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param instance_uuid: A UUID string identifying this Blueprint Instance. (required)
+ :type instance_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._managed_blueprints_used_by_list_serialize(
+ instance_uuid=instance_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _managed_blueprints_used_by_list_serialize(
+ self,
+ instance_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if instance_uuid is not None:
+ _path_params['instance_uuid'] = instance_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/managed/blueprints/{instance_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/oauth2_api.py b/authentik_client/api/oauth2_api.py
new file mode 100644
index 000000000..33ec4892e
--- /dev/null
+++ b/authentik_client/api/oauth2_api.py
@@ -0,0 +1,3508 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from authentik_client.models.expiring_base_grant_model import ExpiringBaseGrantModel
+from authentik_client.models.paginated_expiring_base_grant_model_list import PaginatedExpiringBaseGrantModelList
+from authentik_client.models.paginated_token_model_list import PaginatedTokenModelList
+from authentik_client.models.token_model import TokenModel
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class Oauth2Api:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def oauth2_access_tokens_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """oauth2_access_tokens_destroy
+
+ AccessToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_access_tokens_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """oauth2_access_tokens_destroy
+
+ AccessToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_access_tokens_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_access_tokens_destroy
+
+ AccessToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_access_tokens_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/oauth2/access_tokens/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_access_tokens_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedTokenModelList:
+ """oauth2_access_tokens_list
+
+ AccessToken Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_access_tokens_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedTokenModelList]:
+ """oauth2_access_tokens_list
+
+ AccessToken Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_access_tokens_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_access_tokens_list
+
+ AccessToken Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_access_tokens_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ provider,
+ search,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider is not None:
+
+ _query_params.append(('provider', provider))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/access_tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_access_tokens_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TokenModel:
+ """oauth2_access_tokens_retrieve
+
+ AccessToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_access_tokens_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TokenModel]:
+ """oauth2_access_tokens_retrieve
+
+ AccessToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_access_tokens_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_access_tokens_retrieve
+
+ AccessToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_access_tokens_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/access_tokens/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_access_tokens_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """oauth2_access_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_access_tokens_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """oauth2_access_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_access_tokens_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Access Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_access_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2 Access Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_access_tokens_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_access_tokens_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/access_tokens/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_authorization_codes_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """oauth2_authorization_codes_destroy
+
+ AuthorizationCode Viewset
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_authorization_codes_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """oauth2_authorization_codes_destroy
+
+ AuthorizationCode Viewset
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_authorization_codes_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_authorization_codes_destroy
+
+ AuthorizationCode Viewset
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_authorization_codes_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/oauth2/authorization_codes/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_authorization_codes_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedExpiringBaseGrantModelList:
+ """oauth2_authorization_codes_list
+
+ AuthorizationCode Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExpiringBaseGrantModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_authorization_codes_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedExpiringBaseGrantModelList]:
+ """oauth2_authorization_codes_list
+
+ AuthorizationCode Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExpiringBaseGrantModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_authorization_codes_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_authorization_codes_list
+
+ AuthorizationCode Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExpiringBaseGrantModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_authorization_codes_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ provider,
+ search,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider is not None:
+
+ _query_params.append(('provider', provider))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/authorization_codes/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_authorization_codes_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ExpiringBaseGrantModel:
+ """oauth2_authorization_codes_retrieve
+
+ AuthorizationCode Viewset
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpiringBaseGrantModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_authorization_codes_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ExpiringBaseGrantModel]:
+ """oauth2_authorization_codes_retrieve
+
+ AuthorizationCode Viewset
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpiringBaseGrantModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_authorization_codes_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_authorization_codes_retrieve
+
+ AuthorizationCode Viewset
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpiringBaseGrantModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_authorization_codes_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/authorization_codes/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_authorization_codes_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """oauth2_authorization_codes_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_authorization_codes_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """oauth2_authorization_codes_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_authorization_codes_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Authorization Code.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_authorization_codes_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Authorization Code. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_authorization_codes_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_authorization_codes_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/authorization_codes/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_refresh_tokens_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """oauth2_refresh_tokens_destroy
+
+ RefreshToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_refresh_tokens_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """oauth2_refresh_tokens_destroy
+
+ RefreshToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_refresh_tokens_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_refresh_tokens_destroy
+
+ RefreshToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_refresh_tokens_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/oauth2/refresh_tokens/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_refresh_tokens_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedTokenModelList:
+ """oauth2_refresh_tokens_list
+
+ RefreshToken Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_refresh_tokens_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedTokenModelList]:
+ """oauth2_refresh_tokens_list
+
+ RefreshToken Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_refresh_tokens_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_refresh_tokens_list
+
+ RefreshToken Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param user:
+ :type user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ user=user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTokenModelList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_refresh_tokens_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ provider,
+ search,
+ user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider is not None:
+
+ _query_params.append(('provider', provider))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user is not None:
+
+ _query_params.append(('user', user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/refresh_tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_refresh_tokens_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TokenModel:
+ """oauth2_refresh_tokens_retrieve
+
+ RefreshToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_refresh_tokens_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TokenModel]:
+ """oauth2_refresh_tokens_retrieve
+
+ RefreshToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_refresh_tokens_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_refresh_tokens_retrieve
+
+ RefreshToken Viewset
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TokenModel",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_refresh_tokens_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/refresh_tokens/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def oauth2_refresh_tokens_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """oauth2_refresh_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def oauth2_refresh_tokens_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """oauth2_refresh_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def oauth2_refresh_tokens_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2 Refresh Token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """oauth2_refresh_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2 Refresh Token. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._oauth2_refresh_tokens_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _oauth2_refresh_tokens_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/oauth2/refresh_tokens/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/outposts_api.py b/authentik_client/api/outposts_api.py
new file mode 100644
index 000000000..1d0cfc726
--- /dev/null
+++ b/authentik_client/api/outposts_api.py
@@ -0,0 +1,10218 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.docker_service_connection import DockerServiceConnection
+from authentik_client.models.docker_service_connection_request import DockerServiceConnectionRequest
+from authentik_client.models.kubernetes_service_connection import KubernetesServiceConnection
+from authentik_client.models.kubernetes_service_connection_request import KubernetesServiceConnectionRequest
+from authentik_client.models.ldap_check_access import LDAPCheckAccess
+from authentik_client.models.outpost import Outpost
+from authentik_client.models.outpost_default_config import OutpostDefaultConfig
+from authentik_client.models.outpost_health import OutpostHealth
+from authentik_client.models.outpost_request import OutpostRequest
+from authentik_client.models.paginated_docker_service_connection_list import PaginatedDockerServiceConnectionList
+from authentik_client.models.paginated_kubernetes_service_connection_list import PaginatedKubernetesServiceConnectionList
+from authentik_client.models.paginated_ldap_outpost_config_list import PaginatedLDAPOutpostConfigList
+from authentik_client.models.paginated_outpost_list import PaginatedOutpostList
+from authentik_client.models.paginated_proxy_outpost_config_list import PaginatedProxyOutpostConfigList
+from authentik_client.models.paginated_radius_outpost_config_list import PaginatedRadiusOutpostConfigList
+from authentik_client.models.paginated_service_connection_list import PaginatedServiceConnectionList
+from authentik_client.models.patched_docker_service_connection_request import PatchedDockerServiceConnectionRequest
+from authentik_client.models.patched_kubernetes_service_connection_request import PatchedKubernetesServiceConnectionRequest
+from authentik_client.models.patched_outpost_request import PatchedOutpostRequest
+from authentik_client.models.radius_check_access import RadiusCheckAccess
+from authentik_client.models.service_connection import ServiceConnection
+from authentik_client.models.service_connection_state import ServiceConnectionState
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class OutpostsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def outposts_instances_create(
+ self,
+ outpost_request: OutpostRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Outpost:
+ """outposts_instances_create
+
+ Outpost Viewset
+
+ :param outpost_request: (required)
+ :type outpost_request: OutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_create_serialize(
+ outpost_request=outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_create_with_http_info(
+ self,
+ outpost_request: OutpostRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Outpost]:
+ """outposts_instances_create
+
+ Outpost Viewset
+
+ :param outpost_request: (required)
+ :type outpost_request: OutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_create_serialize(
+ outpost_request=outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_create_without_preload_content(
+ self,
+ outpost_request: OutpostRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_create
+
+ Outpost Viewset
+
+ :param outpost_request: (required)
+ :type outpost_request: OutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_create_serialize(
+ outpost_request=outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_create_serialize(
+ self,
+ outpost_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if outpost_request is not None:
+ _body_params = outpost_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/outposts/instances/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_default_settings_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OutpostDefaultConfig:
+ """outposts_instances_default_settings_retrieve
+
+ Global default outpost config
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_default_settings_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OutpostDefaultConfig",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_default_settings_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OutpostDefaultConfig]:
+ """outposts_instances_default_settings_retrieve
+
+ Global default outpost config
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_default_settings_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OutpostDefaultConfig",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_default_settings_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_default_settings_retrieve
+
+ Global default outpost config
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_default_settings_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OutpostDefaultConfig",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_default_settings_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/instances/default_settings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """outposts_instances_destroy
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """outposts_instances_destroy
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_destroy
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/outposts/instances/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_health_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ managed__icontains: Optional[StrictStr] = None,
+ managed__iexact: Optional[StrictStr] = None,
+ name__icontains: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ providers__isnull: Optional[StrictBool] = None,
+ providers_by_pk: Optional[List[StrictInt]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ service_connection__name__icontains: Optional[StrictStr] = None,
+ service_connection__name__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[OutpostHealth]:
+ """outposts_instances_health_list
+
+ Get outposts current health
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param managed__icontains:
+ :type managed__icontains: str
+ :param managed__iexact:
+ :type managed__iexact: str
+ :param name__icontains:
+ :type name__icontains: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param providers__isnull:
+ :type providers__isnull: bool
+ :param providers_by_pk:
+ :type providers_by_pk: List[int]
+ :param search: A search term.
+ :type search: str
+ :param service_connection__name__icontains:
+ :type service_connection__name__icontains: str
+ :param service_connection__name__iexact:
+ :type service_connection__name__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_health_list_serialize(
+ uuid=uuid,
+ managed__icontains=managed__icontains,
+ managed__iexact=managed__iexact,
+ name__icontains=name__icontains,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ providers__isnull=providers__isnull,
+ providers_by_pk=providers_by_pk,
+ search=search,
+ service_connection__name__icontains=service_connection__name__icontains,
+ service_connection__name__iexact=service_connection__name__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[OutpostHealth]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_health_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ managed__icontains: Optional[StrictStr] = None,
+ managed__iexact: Optional[StrictStr] = None,
+ name__icontains: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ providers__isnull: Optional[StrictBool] = None,
+ providers_by_pk: Optional[List[StrictInt]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ service_connection__name__icontains: Optional[StrictStr] = None,
+ service_connection__name__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[OutpostHealth]]:
+ """outposts_instances_health_list
+
+ Get outposts current health
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param managed__icontains:
+ :type managed__icontains: str
+ :param managed__iexact:
+ :type managed__iexact: str
+ :param name__icontains:
+ :type name__icontains: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param providers__isnull:
+ :type providers__isnull: bool
+ :param providers_by_pk:
+ :type providers_by_pk: List[int]
+ :param search: A search term.
+ :type search: str
+ :param service_connection__name__icontains:
+ :type service_connection__name__icontains: str
+ :param service_connection__name__iexact:
+ :type service_connection__name__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_health_list_serialize(
+ uuid=uuid,
+ managed__icontains=managed__icontains,
+ managed__iexact=managed__iexact,
+ name__icontains=name__icontains,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ providers__isnull=providers__isnull,
+ providers_by_pk=providers_by_pk,
+ search=search,
+ service_connection__name__icontains=service_connection__name__icontains,
+ service_connection__name__iexact=service_connection__name__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[OutpostHealth]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_health_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ managed__icontains: Optional[StrictStr] = None,
+ managed__iexact: Optional[StrictStr] = None,
+ name__icontains: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ providers__isnull: Optional[StrictBool] = None,
+ providers_by_pk: Optional[List[StrictInt]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ service_connection__name__icontains: Optional[StrictStr] = None,
+ service_connection__name__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_health_list
+
+ Get outposts current health
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param managed__icontains:
+ :type managed__icontains: str
+ :param managed__iexact:
+ :type managed__iexact: str
+ :param name__icontains:
+ :type name__icontains: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param providers__isnull:
+ :type providers__isnull: bool
+ :param providers_by_pk:
+ :type providers_by_pk: List[int]
+ :param search: A search term.
+ :type search: str
+ :param service_connection__name__icontains:
+ :type service_connection__name__icontains: str
+ :param service_connection__name__iexact:
+ :type service_connection__name__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_health_list_serialize(
+ uuid=uuid,
+ managed__icontains=managed__icontains,
+ managed__iexact=managed__iexact,
+ name__icontains=name__icontains,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ providers__isnull=providers__isnull,
+ providers_by_pk=providers_by_pk,
+ search=search,
+ service_connection__name__icontains=service_connection__name__icontains,
+ service_connection__name__iexact=service_connection__name__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[OutpostHealth]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_health_list_serialize(
+ self,
+ uuid,
+ managed__icontains,
+ managed__iexact,
+ name__icontains,
+ name__iexact,
+ ordering,
+ providers__isnull,
+ providers_by_pk,
+ search,
+ service_connection__name__icontains,
+ service_connection__name__iexact,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'providers_by_pk': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ if managed__icontains is not None:
+
+ _query_params.append(('managed__icontains', managed__icontains))
+
+ if managed__iexact is not None:
+
+ _query_params.append(('managed__iexact', managed__iexact))
+
+ if name__icontains is not None:
+
+ _query_params.append(('name__icontains', name__icontains))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if providers__isnull is not None:
+
+ _query_params.append(('providers__isnull', providers__isnull))
+
+ if providers_by_pk is not None:
+
+ _query_params.append(('providers_by_pk', providers_by_pk))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if service_connection__name__icontains is not None:
+
+ _query_params.append(('service_connection__name__icontains', service_connection__name__icontains))
+
+ if service_connection__name__iexact is not None:
+
+ _query_params.append(('service_connection__name__iexact', service_connection__name__iexact))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/instances/{uuid}/health/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_list(
+ self,
+ managed__icontains: Optional[StrictStr] = None,
+ managed__iexact: Optional[StrictStr] = None,
+ name__icontains: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ providers__isnull: Optional[StrictBool] = None,
+ providers_by_pk: Optional[List[StrictInt]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ service_connection__name__icontains: Optional[StrictStr] = None,
+ service_connection__name__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedOutpostList:
+ """outposts_instances_list
+
+ Outpost Viewset
+
+ :param managed__icontains:
+ :type managed__icontains: str
+ :param managed__iexact:
+ :type managed__iexact: str
+ :param name__icontains:
+ :type name__icontains: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param providers__isnull:
+ :type providers__isnull: bool
+ :param providers_by_pk:
+ :type providers_by_pk: List[int]
+ :param search: A search term.
+ :type search: str
+ :param service_connection__name__icontains:
+ :type service_connection__name__icontains: str
+ :param service_connection__name__iexact:
+ :type service_connection__name__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_list_serialize(
+ managed__icontains=managed__icontains,
+ managed__iexact=managed__iexact,
+ name__icontains=name__icontains,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ providers__isnull=providers__isnull,
+ providers_by_pk=providers_by_pk,
+ search=search,
+ service_connection__name__icontains=service_connection__name__icontains,
+ service_connection__name__iexact=service_connection__name__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOutpostList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_list_with_http_info(
+ self,
+ managed__icontains: Optional[StrictStr] = None,
+ managed__iexact: Optional[StrictStr] = None,
+ name__icontains: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ providers__isnull: Optional[StrictBool] = None,
+ providers_by_pk: Optional[List[StrictInt]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ service_connection__name__icontains: Optional[StrictStr] = None,
+ service_connection__name__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedOutpostList]:
+ """outposts_instances_list
+
+ Outpost Viewset
+
+ :param managed__icontains:
+ :type managed__icontains: str
+ :param managed__iexact:
+ :type managed__iexact: str
+ :param name__icontains:
+ :type name__icontains: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param providers__isnull:
+ :type providers__isnull: bool
+ :param providers_by_pk:
+ :type providers_by_pk: List[int]
+ :param search: A search term.
+ :type search: str
+ :param service_connection__name__icontains:
+ :type service_connection__name__icontains: str
+ :param service_connection__name__iexact:
+ :type service_connection__name__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_list_serialize(
+ managed__icontains=managed__icontains,
+ managed__iexact=managed__iexact,
+ name__icontains=name__icontains,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ providers__isnull=providers__isnull,
+ providers_by_pk=providers_by_pk,
+ search=search,
+ service_connection__name__icontains=service_connection__name__icontains,
+ service_connection__name__iexact=service_connection__name__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOutpostList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_list_without_preload_content(
+ self,
+ managed__icontains: Optional[StrictStr] = None,
+ managed__iexact: Optional[StrictStr] = None,
+ name__icontains: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ providers__isnull: Optional[StrictBool] = None,
+ providers_by_pk: Optional[List[StrictInt]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ service_connection__name__icontains: Optional[StrictStr] = None,
+ service_connection__name__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_list
+
+ Outpost Viewset
+
+ :param managed__icontains:
+ :type managed__icontains: str
+ :param managed__iexact:
+ :type managed__iexact: str
+ :param name__icontains:
+ :type name__icontains: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param providers__isnull:
+ :type providers__isnull: bool
+ :param providers_by_pk:
+ :type providers_by_pk: List[int]
+ :param search: A search term.
+ :type search: str
+ :param service_connection__name__icontains:
+ :type service_connection__name__icontains: str
+ :param service_connection__name__iexact:
+ :type service_connection__name__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_list_serialize(
+ managed__icontains=managed__icontains,
+ managed__iexact=managed__iexact,
+ name__icontains=name__icontains,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ providers__isnull=providers__isnull,
+ providers_by_pk=providers_by_pk,
+ search=search,
+ service_connection__name__icontains=service_connection__name__icontains,
+ service_connection__name__iexact=service_connection__name__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOutpostList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_list_serialize(
+ self,
+ managed__icontains,
+ managed__iexact,
+ name__icontains,
+ name__iexact,
+ ordering,
+ page,
+ page_size,
+ providers__isnull,
+ providers_by_pk,
+ search,
+ service_connection__name__icontains,
+ service_connection__name__iexact,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'providers_by_pk': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed__icontains is not None:
+
+ _query_params.append(('managed__icontains', managed__icontains))
+
+ if managed__iexact is not None:
+
+ _query_params.append(('managed__iexact', managed__iexact))
+
+ if name__icontains is not None:
+
+ _query_params.append(('name__icontains', name__icontains))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if providers__isnull is not None:
+
+ _query_params.append(('providers__isnull', providers__isnull))
+
+ if providers_by_pk is not None:
+
+ _query_params.append(('providers_by_pk', providers_by_pk))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if service_connection__name__icontains is not None:
+
+ _query_params.append(('service_connection__name__icontains', service_connection__name__icontains))
+
+ if service_connection__name__iexact is not None:
+
+ _query_params.append(('service_connection__name__iexact', service_connection__name__iexact))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/instances/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ patched_outpost_request: Optional[PatchedOutpostRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Outpost:
+ """outposts_instances_partial_update
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param patched_outpost_request:
+ :type patched_outpost_request: PatchedOutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_partial_update_serialize(
+ uuid=uuid,
+ patched_outpost_request=patched_outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ patched_outpost_request: Optional[PatchedOutpostRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Outpost]:
+ """outposts_instances_partial_update
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param patched_outpost_request:
+ :type patched_outpost_request: PatchedOutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_partial_update_serialize(
+ uuid=uuid,
+ patched_outpost_request=patched_outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ patched_outpost_request: Optional[PatchedOutpostRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_partial_update
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param patched_outpost_request:
+ :type patched_outpost_request: PatchedOutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_partial_update_serialize(
+ uuid=uuid,
+ patched_outpost_request=patched_outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_partial_update_serialize(
+ self,
+ uuid,
+ patched_outpost_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_outpost_request is not None:
+ _body_params = patched_outpost_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/outposts/instances/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Outpost:
+ """outposts_instances_retrieve
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Outpost]:
+ """outposts_instances_retrieve
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_retrieve
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/instances/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ outpost_request: OutpostRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Outpost:
+ """outposts_instances_update
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param outpost_request: (required)
+ :type outpost_request: OutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_update_serialize(
+ uuid=uuid,
+ outpost_request=outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ outpost_request: OutpostRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Outpost]:
+ """outposts_instances_update
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param outpost_request: (required)
+ :type outpost_request: OutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_update_serialize(
+ uuid=uuid,
+ outpost_request=outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ outpost_request: OutpostRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_update
+
+ Outpost Viewset
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param outpost_request: (required)
+ :type outpost_request: OutpostRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_update_serialize(
+ uuid=uuid,
+ outpost_request=outpost_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Outpost",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_update_serialize(
+ self,
+ uuid,
+ outpost_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if outpost_request is not None:
+ _body_params = outpost_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/outposts/instances/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_instances_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """outposts_instances_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_instances_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """outposts_instances_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_instances_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_instances_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Outpost. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_instances_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_instances_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/instances/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_ldap_access_check(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ app_slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPCheckAccess:
+ """outposts_ldap_access_check
+
+ Check access to a single application by slug
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param app_slug:
+ :type app_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_ldap_access_check_serialize(
+ id=id,
+ app_slug=app_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPCheckAccess",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_ldap_access_check_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ app_slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPCheckAccess]:
+ """outposts_ldap_access_check
+
+ Check access to a single application by slug
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param app_slug:
+ :type app_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_ldap_access_check_serialize(
+ id=id,
+ app_slug=app_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPCheckAccess",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_ldap_access_check_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ app_slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_ldap_access_check
+
+ Check access to a single application by slug
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param app_slug:
+ :type app_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_ldap_access_check_serialize(
+ id=id,
+ app_slug=app_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPCheckAccess",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_ldap_access_check_serialize(
+ self,
+ id,
+ app_slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if app_slug is not None:
+
+ _query_params.append(('app_slug', app_slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/ldap/{id}/check_access/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_ldap_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedLDAPOutpostConfigList:
+ """outposts_ldap_list
+
+ LDAPProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_ldap_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_ldap_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedLDAPOutpostConfigList]:
+ """outposts_ldap_list
+
+ LDAPProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_ldap_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_ldap_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_ldap_list
+
+ LDAPProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_ldap_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_ldap_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_proxy_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedProxyOutpostConfigList:
+ """outposts_proxy_list
+
+ ProxyProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_proxy_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProxyOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_proxy_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedProxyOutpostConfigList]:
+ """outposts_proxy_list
+
+ ProxyProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_proxy_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProxyOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_proxy_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_proxy_list
+
+ ProxyProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_proxy_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProxyOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_proxy_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/proxy/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_radius_access_check(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ app_slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusCheckAccess:
+ """outposts_radius_access_check
+
+ Check access to a single application by slug
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param app_slug:
+ :type app_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_radius_access_check_serialize(
+ id=id,
+ app_slug=app_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusCheckAccess",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_radius_access_check_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ app_slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusCheckAccess]:
+ """outposts_radius_access_check
+
+ Check access to a single application by slug
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param app_slug:
+ :type app_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_radius_access_check_serialize(
+ id=id,
+ app_slug=app_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusCheckAccess",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_radius_access_check_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ app_slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_radius_access_check
+
+ Check access to a single application by slug
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param app_slug:
+ :type app_slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_radius_access_check_serialize(
+ id=id,
+ app_slug=app_slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusCheckAccess",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_radius_access_check_serialize(
+ self,
+ id,
+ app_slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if app_slug is not None:
+
+ _query_params.append(('app_slug', app_slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/radius/{id}/check_access/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_radius_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRadiusOutpostConfigList:
+ """outposts_radius_list
+
+ RadiusProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_radius_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_radius_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRadiusOutpostConfigList]:
+ """outposts_radius_list
+
+ RadiusProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_radius_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_radius_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_radius_list
+
+ RadiusProvider Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_radius_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusOutpostConfigList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_radius_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/radius/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_all_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """outposts_service_connections_all_destroy
+
+ ServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_all_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """outposts_service_connections_all_destroy
+
+ ServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_all_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_all_destroy
+
+ ServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_all_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/outposts/service_connections/all/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_all_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedServiceConnectionList:
+ """outposts_service_connections_all_list
+
+ ServiceConnection Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_all_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedServiceConnectionList]:
+ """outposts_service_connections_all_list
+
+ ServiceConnection Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_all_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_all_list
+
+ ServiceConnection Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_all_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_all_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ServiceConnection:
+ """outposts_service_connections_all_retrieve
+
+ ServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_all_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ServiceConnection]:
+ """outposts_service_connections_all_retrieve
+
+ ServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_all_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_all_retrieve
+
+ ServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_all_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/all/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_all_state_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ServiceConnectionState:
+ """outposts_service_connections_all_state_retrieve
+
+ Get the service connection's state
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_state_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ServiceConnectionState",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_all_state_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ServiceConnectionState]:
+ """outposts_service_connections_all_state_retrieve
+
+ Get the service connection's state
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_state_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ServiceConnectionState",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_all_state_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_all_state_retrieve
+
+ Get the service connection's state
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_state_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ServiceConnectionState",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_all_state_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/all/{uuid}/state/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_all_types_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """outposts_service_connections_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_all_types_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """outposts_service_connections_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_all_types_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_all_types_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/all/types/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_all_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """outposts_service_connections_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_all_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """outposts_service_connections_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_all_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Outpost Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Outpost Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_all_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_all_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/all/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_create(
+ self,
+ docker_service_connection_request: DockerServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DockerServiceConnection:
+ """outposts_service_connections_docker_create
+
+ DockerServiceConnection Viewset
+
+ :param docker_service_connection_request: (required)
+ :type docker_service_connection_request: DockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_create_serialize(
+ docker_service_connection_request=docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_create_with_http_info(
+ self,
+ docker_service_connection_request: DockerServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DockerServiceConnection]:
+ """outposts_service_connections_docker_create
+
+ DockerServiceConnection Viewset
+
+ :param docker_service_connection_request: (required)
+ :type docker_service_connection_request: DockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_create_serialize(
+ docker_service_connection_request=docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_create_without_preload_content(
+ self,
+ docker_service_connection_request: DockerServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_create
+
+ DockerServiceConnection Viewset
+
+ :param docker_service_connection_request: (required)
+ :type docker_service_connection_request: DockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_create_serialize(
+ docker_service_connection_request=docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_create_serialize(
+ self,
+ docker_service_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if docker_service_connection_request is not None:
+ _body_params = docker_service_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/outposts/service_connections/docker/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """outposts_service_connections_docker_destroy
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """outposts_service_connections_docker_destroy
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_destroy
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/outposts/service_connections/docker/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_list(
+ self,
+ local: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ tls_authentication: Optional[UUID] = None,
+ tls_verification: Optional[UUID] = None,
+ url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDockerServiceConnectionList:
+ """outposts_service_connections_docker_list
+
+ DockerServiceConnection Viewset
+
+ :param local:
+ :type local: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param tls_authentication:
+ :type tls_authentication: UUID
+ :param tls_verification:
+ :type tls_verification: UUID
+ :param url:
+ :type url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_list_serialize(
+ local=local,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ tls_authentication=tls_authentication,
+ tls_verification=tls_verification,
+ url=url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDockerServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_list_with_http_info(
+ self,
+ local: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ tls_authentication: Optional[UUID] = None,
+ tls_verification: Optional[UUID] = None,
+ url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDockerServiceConnectionList]:
+ """outposts_service_connections_docker_list
+
+ DockerServiceConnection Viewset
+
+ :param local:
+ :type local: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param tls_authentication:
+ :type tls_authentication: UUID
+ :param tls_verification:
+ :type tls_verification: UUID
+ :param url:
+ :type url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_list_serialize(
+ local=local,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ tls_authentication=tls_authentication,
+ tls_verification=tls_verification,
+ url=url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDockerServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_list_without_preload_content(
+ self,
+ local: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ tls_authentication: Optional[UUID] = None,
+ tls_verification: Optional[UUID] = None,
+ url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_list
+
+ DockerServiceConnection Viewset
+
+ :param local:
+ :type local: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param tls_authentication:
+ :type tls_authentication: UUID
+ :param tls_verification:
+ :type tls_verification: UUID
+ :param url:
+ :type url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_list_serialize(
+ local=local,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ tls_authentication=tls_authentication,
+ tls_verification=tls_verification,
+ url=url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDockerServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_list_serialize(
+ self,
+ local,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ tls_authentication,
+ tls_verification,
+ url,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if local is not None:
+
+ _query_params.append(('local', local))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if tls_authentication is not None:
+
+ _query_params.append(('tls_authentication', tls_authentication))
+
+ if tls_verification is not None:
+
+ _query_params.append(('tls_verification', tls_verification))
+
+ if url is not None:
+
+ _query_params.append(('url', url))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/docker/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ patched_docker_service_connection_request: Optional[PatchedDockerServiceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DockerServiceConnection:
+ """outposts_service_connections_docker_partial_update
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param patched_docker_service_connection_request:
+ :type patched_docker_service_connection_request: PatchedDockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_partial_update_serialize(
+ uuid=uuid,
+ patched_docker_service_connection_request=patched_docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ patched_docker_service_connection_request: Optional[PatchedDockerServiceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DockerServiceConnection]:
+ """outposts_service_connections_docker_partial_update
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param patched_docker_service_connection_request:
+ :type patched_docker_service_connection_request: PatchedDockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_partial_update_serialize(
+ uuid=uuid,
+ patched_docker_service_connection_request=patched_docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ patched_docker_service_connection_request: Optional[PatchedDockerServiceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_partial_update
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param patched_docker_service_connection_request:
+ :type patched_docker_service_connection_request: PatchedDockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_partial_update_serialize(
+ uuid=uuid,
+ patched_docker_service_connection_request=patched_docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_partial_update_serialize(
+ self,
+ uuid,
+ patched_docker_service_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_docker_service_connection_request is not None:
+ _body_params = patched_docker_service_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/outposts/service_connections/docker/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DockerServiceConnection:
+ """outposts_service_connections_docker_retrieve
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DockerServiceConnection]:
+ """outposts_service_connections_docker_retrieve
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_retrieve
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/docker/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ docker_service_connection_request: DockerServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DockerServiceConnection:
+ """outposts_service_connections_docker_update
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param docker_service_connection_request: (required)
+ :type docker_service_connection_request: DockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_update_serialize(
+ uuid=uuid,
+ docker_service_connection_request=docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ docker_service_connection_request: DockerServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DockerServiceConnection]:
+ """outposts_service_connections_docker_update
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param docker_service_connection_request: (required)
+ :type docker_service_connection_request: DockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_update_serialize(
+ uuid=uuid,
+ docker_service_connection_request=docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ docker_service_connection_request: DockerServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_update
+
+ DockerServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param docker_service_connection_request: (required)
+ :type docker_service_connection_request: DockerServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_update_serialize(
+ uuid=uuid,
+ docker_service_connection_request=docker_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DockerServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_update_serialize(
+ self,
+ uuid,
+ docker_service_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if docker_service_connection_request is not None:
+ _body_params = docker_service_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/outposts/service_connections/docker/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_docker_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """outposts_service_connections_docker_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_docker_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """outposts_service_connections_docker_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_docker_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Docker Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_docker_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Docker Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_docker_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_docker_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/docker/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_create(
+ self,
+ kubernetes_service_connection_request: KubernetesServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KubernetesServiceConnection:
+ """outposts_service_connections_kubernetes_create
+
+ KubernetesServiceConnection Viewset
+
+ :param kubernetes_service_connection_request: (required)
+ :type kubernetes_service_connection_request: KubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_create_serialize(
+ kubernetes_service_connection_request=kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_create_with_http_info(
+ self,
+ kubernetes_service_connection_request: KubernetesServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KubernetesServiceConnection]:
+ """outposts_service_connections_kubernetes_create
+
+ KubernetesServiceConnection Viewset
+
+ :param kubernetes_service_connection_request: (required)
+ :type kubernetes_service_connection_request: KubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_create_serialize(
+ kubernetes_service_connection_request=kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_create_without_preload_content(
+ self,
+ kubernetes_service_connection_request: KubernetesServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_create
+
+ KubernetesServiceConnection Viewset
+
+ :param kubernetes_service_connection_request: (required)
+ :type kubernetes_service_connection_request: KubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_create_serialize(
+ kubernetes_service_connection_request=kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_create_serialize(
+ self,
+ kubernetes_service_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if kubernetes_service_connection_request is not None:
+ _body_params = kubernetes_service_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/outposts/service_connections/kubernetes/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """outposts_service_connections_kubernetes_destroy
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """outposts_service_connections_kubernetes_destroy
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_destroy
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/outposts/service_connections/kubernetes/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_list(
+ self,
+ local: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedKubernetesServiceConnectionList:
+ """outposts_service_connections_kubernetes_list
+
+ KubernetesServiceConnection Viewset
+
+ :param local:
+ :type local: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_list_serialize(
+ local=local,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedKubernetesServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_list_with_http_info(
+ self,
+ local: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedKubernetesServiceConnectionList]:
+ """outposts_service_connections_kubernetes_list
+
+ KubernetesServiceConnection Viewset
+
+ :param local:
+ :type local: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_list_serialize(
+ local=local,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedKubernetesServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_list_without_preload_content(
+ self,
+ local: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_list
+
+ KubernetesServiceConnection Viewset
+
+ :param local:
+ :type local: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_list_serialize(
+ local=local,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedKubernetesServiceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_list_serialize(
+ self,
+ local,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if local is not None:
+
+ _query_params.append(('local', local))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/kubernetes/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ patched_kubernetes_service_connection_request: Optional[PatchedKubernetesServiceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KubernetesServiceConnection:
+ """outposts_service_connections_kubernetes_partial_update
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param patched_kubernetes_service_connection_request:
+ :type patched_kubernetes_service_connection_request: PatchedKubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_partial_update_serialize(
+ uuid=uuid,
+ patched_kubernetes_service_connection_request=patched_kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ patched_kubernetes_service_connection_request: Optional[PatchedKubernetesServiceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KubernetesServiceConnection]:
+ """outposts_service_connections_kubernetes_partial_update
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param patched_kubernetes_service_connection_request:
+ :type patched_kubernetes_service_connection_request: PatchedKubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_partial_update_serialize(
+ uuid=uuid,
+ patched_kubernetes_service_connection_request=patched_kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ patched_kubernetes_service_connection_request: Optional[PatchedKubernetesServiceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_partial_update
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param patched_kubernetes_service_connection_request:
+ :type patched_kubernetes_service_connection_request: PatchedKubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_partial_update_serialize(
+ uuid=uuid,
+ patched_kubernetes_service_connection_request=patched_kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_partial_update_serialize(
+ self,
+ uuid,
+ patched_kubernetes_service_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_kubernetes_service_connection_request is not None:
+ _body_params = patched_kubernetes_service_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/outposts/service_connections/kubernetes/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KubernetesServiceConnection:
+ """outposts_service_connections_kubernetes_retrieve
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KubernetesServiceConnection]:
+ """outposts_service_connections_kubernetes_retrieve
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_retrieve
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/kubernetes/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ kubernetes_service_connection_request: KubernetesServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KubernetesServiceConnection:
+ """outposts_service_connections_kubernetes_update
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param kubernetes_service_connection_request: (required)
+ :type kubernetes_service_connection_request: KubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_update_serialize(
+ uuid=uuid,
+ kubernetes_service_connection_request=kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ kubernetes_service_connection_request: KubernetesServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KubernetesServiceConnection]:
+ """outposts_service_connections_kubernetes_update
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param kubernetes_service_connection_request: (required)
+ :type kubernetes_service_connection_request: KubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_update_serialize(
+ uuid=uuid,
+ kubernetes_service_connection_request=kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ kubernetes_service_connection_request: KubernetesServiceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_update
+
+ KubernetesServiceConnection Viewset
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param kubernetes_service_connection_request: (required)
+ :type kubernetes_service_connection_request: KubernetesServiceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_update_serialize(
+ uuid=uuid,
+ kubernetes_service_connection_request=kubernetes_service_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KubernetesServiceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_update_serialize(
+ self,
+ uuid,
+ kubernetes_service_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if kubernetes_service_connection_request is not None:
+ _body_params = kubernetes_service_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/outposts/service_connections/kubernetes/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """outposts_service_connections_kubernetes_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """outposts_service_connections_kubernetes_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def outposts_service_connections_kubernetes_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Kubernetes Service-Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """outposts_service_connections_kubernetes_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Kubernetes Service-Connection. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._outposts_service_connections_kubernetes_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _outposts_service_connections_kubernetes_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/outposts/service_connections/kubernetes/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/policies_api.py b/authentik_client/api/policies_api.py
new file mode 100644
index 000000000..5f9c8361c
--- /dev/null
+++ b/authentik_client/api/policies_api.py
@@ -0,0 +1,23004 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from datetime import datetime
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import Any, List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.cache import Cache
+from authentik_client.models.detailed_country import DetailedCountry
+from authentik_client.models.dummy_policy import DummyPolicy
+from authentik_client.models.dummy_policy_request import DummyPolicyRequest
+from authentik_client.models.event_matcher_policy import EventMatcherPolicy
+from authentik_client.models.event_matcher_policy_request import EventMatcherPolicyRequest
+from authentik_client.models.expression_policy import ExpressionPolicy
+from authentik_client.models.expression_policy_request import ExpressionPolicyRequest
+from authentik_client.models.geo_ip_policy import GeoIPPolicy
+from authentik_client.models.geo_ip_policy_request import GeoIPPolicyRequest
+from authentik_client.models.paginated_dummy_policy_list import PaginatedDummyPolicyList
+from authentik_client.models.paginated_event_matcher_policy_list import PaginatedEventMatcherPolicyList
+from authentik_client.models.paginated_expression_policy_list import PaginatedExpressionPolicyList
+from authentik_client.models.paginated_geo_ip_policy_list import PaginatedGeoIPPolicyList
+from authentik_client.models.paginated_password_expiry_policy_list import PaginatedPasswordExpiryPolicyList
+from authentik_client.models.paginated_password_policy_list import PaginatedPasswordPolicyList
+from authentik_client.models.paginated_policy_binding_list import PaginatedPolicyBindingList
+from authentik_client.models.paginated_policy_list import PaginatedPolicyList
+from authentik_client.models.paginated_reputation_list import PaginatedReputationList
+from authentik_client.models.paginated_reputation_policy_list import PaginatedReputationPolicyList
+from authentik_client.models.paginated_unique_password_policy_list import PaginatedUniquePasswordPolicyList
+from authentik_client.models.password_expiry_policy import PasswordExpiryPolicy
+from authentik_client.models.password_expiry_policy_request import PasswordExpiryPolicyRequest
+from authentik_client.models.password_policy import PasswordPolicy
+from authentik_client.models.password_policy_request import PasswordPolicyRequest
+from authentik_client.models.patched_dummy_policy_request import PatchedDummyPolicyRequest
+from authentik_client.models.patched_event_matcher_policy_request import PatchedEventMatcherPolicyRequest
+from authentik_client.models.patched_expression_policy_request import PatchedExpressionPolicyRequest
+from authentik_client.models.patched_geo_ip_policy_request import PatchedGeoIPPolicyRequest
+from authentik_client.models.patched_password_expiry_policy_request import PatchedPasswordExpiryPolicyRequest
+from authentik_client.models.patched_password_policy_request import PatchedPasswordPolicyRequest
+from authentik_client.models.patched_policy_binding_request import PatchedPolicyBindingRequest
+from authentik_client.models.patched_reputation_policy_request import PatchedReputationPolicyRequest
+from authentik_client.models.patched_unique_password_policy_request import PatchedUniquePasswordPolicyRequest
+from authentik_client.models.policy import Policy
+from authentik_client.models.policy_binding import PolicyBinding
+from authentik_client.models.policy_binding_request import PolicyBindingRequest
+from authentik_client.models.policy_test_request import PolicyTestRequest
+from authentik_client.models.policy_test_result import PolicyTestResult
+from authentik_client.models.reputation import Reputation
+from authentik_client.models.reputation_policy import ReputationPolicy
+from authentik_client.models.reputation_policy_request import ReputationPolicyRequest
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.unique_password_policy import UniquePasswordPolicy
+from authentik_client.models.unique_password_policy_request import UniquePasswordPolicyRequest
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class PoliciesApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def policies_all_cache_clear_create(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_all_cache_clear_create
+
+ Clear policy cache
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_cache_clear_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_cache_clear_create_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_all_cache_clear_create
+
+ Clear policy cache
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_cache_clear_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_cache_clear_create_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_cache_clear_create
+
+ Clear policy cache
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_cache_clear_create_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_cache_clear_create_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/all/cache_clear/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_cache_info_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Cache:
+ """policies_all_cache_info_retrieve
+
+ Info about cached policies
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_cache_info_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Cache",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_cache_info_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Cache]:
+ """policies_all_cache_info_retrieve
+
+ Info about cached policies
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_cache_info_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Cache",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_cache_info_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_cache_info_retrieve
+
+ Info about cached policies
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_cache_info_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Cache",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_cache_info_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/all/cache_info/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_all_destroy
+
+ Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_all_destroy
+
+ Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_destroy
+
+ Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/all/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_list(
+ self,
+ bindings__isnull: Optional[StrictBool] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ promptstage__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPolicyList:
+ """policies_all_list
+
+ Policy Viewset
+
+ :param bindings__isnull:
+ :type bindings__isnull: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param promptstage__isnull:
+ :type promptstage__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_list_serialize(
+ bindings__isnull=bindings__isnull,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ promptstage__isnull=promptstage__isnull,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_list_with_http_info(
+ self,
+ bindings__isnull: Optional[StrictBool] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ promptstage__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPolicyList]:
+ """policies_all_list
+
+ Policy Viewset
+
+ :param bindings__isnull:
+ :type bindings__isnull: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param promptstage__isnull:
+ :type promptstage__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_list_serialize(
+ bindings__isnull=bindings__isnull,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ promptstage__isnull=promptstage__isnull,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_list_without_preload_content(
+ self,
+ bindings__isnull: Optional[StrictBool] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ promptstage__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_list
+
+ Policy Viewset
+
+ :param bindings__isnull:
+ :type bindings__isnull: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param promptstage__isnull:
+ :type promptstage__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_list_serialize(
+ bindings__isnull=bindings__isnull,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ promptstage__isnull=promptstage__isnull,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_list_serialize(
+ self,
+ bindings__isnull,
+ ordering,
+ page,
+ page_size,
+ promptstage__isnull,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if bindings__isnull is not None:
+
+ _query_params.append(('bindings__isnull', bindings__isnull))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if promptstage__isnull is not None:
+
+ _query_params.append(('promptstage__isnull', promptstage__isnull))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Policy:
+ """policies_all_retrieve
+
+ Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Policy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Policy]:
+ """policies_all_retrieve
+
+ Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Policy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_retrieve
+
+ Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Policy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/all/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_test_create(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ policy_test_request: PolicyTestRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PolicyTestResult:
+ """policies_all_test_create
+
+ Test policy
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param policy_test_request: (required)
+ :type policy_test_request: PolicyTestRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_test_create_serialize(
+ policy_uuid=policy_uuid,
+ policy_test_request=policy_test_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyTestResult",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_test_create_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ policy_test_request: PolicyTestRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PolicyTestResult]:
+ """policies_all_test_create
+
+ Test policy
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param policy_test_request: (required)
+ :type policy_test_request: PolicyTestRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_test_create_serialize(
+ policy_uuid=policy_uuid,
+ policy_test_request=policy_test_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyTestResult",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_test_create_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ policy_test_request: PolicyTestRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_test_create
+
+ Test policy
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param policy_test_request: (required)
+ :type policy_test_request: PolicyTestRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_test_create_serialize(
+ policy_uuid=policy_uuid,
+ policy_test_request=policy_test_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyTestResult",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_test_create_serialize(
+ self,
+ policy_uuid,
+ policy_test_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if policy_test_request is not None:
+ _body_params = policy_test_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/all/{policy_uuid}/test/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_types_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """policies_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_types_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """policies_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_types_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_types_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/all/types/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_all_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_all_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_all_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_all_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_all_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/all/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_create(
+ self,
+ policy_binding_request: PolicyBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PolicyBinding:
+ """policies_bindings_create
+
+ PolicyBinding Viewset
+
+ :param policy_binding_request: (required)
+ :type policy_binding_request: PolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_create_serialize(
+ policy_binding_request=policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_create_with_http_info(
+ self,
+ policy_binding_request: PolicyBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PolicyBinding]:
+ """policies_bindings_create
+
+ PolicyBinding Viewset
+
+ :param policy_binding_request: (required)
+ :type policy_binding_request: PolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_create_serialize(
+ policy_binding_request=policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_create_without_preload_content(
+ self,
+ policy_binding_request: PolicyBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_create
+
+ PolicyBinding Viewset
+
+ :param policy_binding_request: (required)
+ :type policy_binding_request: PolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_create_serialize(
+ policy_binding_request=policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_create_serialize(
+ self,
+ policy_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if policy_binding_request is not None:
+ _body_params = policy_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/bindings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_destroy(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_bindings_destroy
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_destroy_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_destroy_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_bindings_destroy
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_destroy_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_destroy_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_destroy
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_destroy_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_destroy_serialize(
+ self,
+ policy_binding_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_list(
+ self,
+ enabled: Optional[StrictBool] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy: Optional[UUID] = None,
+ policy__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ target: Optional[UUID] = None,
+ target_in: Optional[List[UUID]] = None,
+ timeout: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPolicyBindingList:
+ """policies_bindings_list
+
+ PolicyBinding Viewset
+
+ :param enabled:
+ :type enabled: bool
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy:
+ :type policy: UUID
+ :param policy__isnull:
+ :type policy__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param target:
+ :type target: UUID
+ :param target_in:
+ :type target_in: List[UUID]
+ :param timeout:
+ :type timeout: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_list_serialize(
+ enabled=enabled,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy=policy,
+ policy__isnull=policy__isnull,
+ search=search,
+ target=target,
+ target_in=target_in,
+ timeout=timeout,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPolicyBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_list_with_http_info(
+ self,
+ enabled: Optional[StrictBool] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy: Optional[UUID] = None,
+ policy__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ target: Optional[UUID] = None,
+ target_in: Optional[List[UUID]] = None,
+ timeout: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPolicyBindingList]:
+ """policies_bindings_list
+
+ PolicyBinding Viewset
+
+ :param enabled:
+ :type enabled: bool
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy:
+ :type policy: UUID
+ :param policy__isnull:
+ :type policy__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param target:
+ :type target: UUID
+ :param target_in:
+ :type target_in: List[UUID]
+ :param timeout:
+ :type timeout: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_list_serialize(
+ enabled=enabled,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy=policy,
+ policy__isnull=policy__isnull,
+ search=search,
+ target=target,
+ target_in=target_in,
+ timeout=timeout,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPolicyBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_list_without_preload_content(
+ self,
+ enabled: Optional[StrictBool] = None,
+ order: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy: Optional[UUID] = None,
+ policy__isnull: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ target: Optional[UUID] = None,
+ target_in: Optional[List[UUID]] = None,
+ timeout: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_list
+
+ PolicyBinding Viewset
+
+ :param enabled:
+ :type enabled: bool
+ :param order:
+ :type order: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy:
+ :type policy: UUID
+ :param policy__isnull:
+ :type policy__isnull: bool
+ :param search: A search term.
+ :type search: str
+ :param target:
+ :type target: UUID
+ :param target_in:
+ :type target_in: List[UUID]
+ :param timeout:
+ :type timeout: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_list_serialize(
+ enabled=enabled,
+ order=order,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy=policy,
+ policy__isnull=policy__isnull,
+ search=search,
+ target=target,
+ target_in=target_in,
+ timeout=timeout,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPolicyBindingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_list_serialize(
+ self,
+ enabled,
+ order,
+ ordering,
+ page,
+ page_size,
+ policy,
+ policy__isnull,
+ search,
+ target,
+ target_in,
+ timeout,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'target_in': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if enabled is not None:
+
+ _query_params.append(('enabled', enabled))
+
+ if order is not None:
+
+ _query_params.append(('order', order))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy is not None:
+
+ _query_params.append(('policy', policy))
+
+ if policy__isnull is not None:
+
+ _query_params.append(('policy__isnull', policy__isnull))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if target is not None:
+
+ _query_params.append(('target', target))
+
+ if target_in is not None:
+
+ _query_params.append(('target_in', target_in))
+
+ if timeout is not None:
+
+ _query_params.append(('timeout', timeout))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/bindings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_partial_update(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ patched_policy_binding_request: Optional[PatchedPolicyBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PolicyBinding:
+ """policies_bindings_partial_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param patched_policy_binding_request:
+ :type patched_policy_binding_request: PatchedPolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_partial_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ patched_policy_binding_request=patched_policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_partial_update_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ patched_policy_binding_request: Optional[PatchedPolicyBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PolicyBinding]:
+ """policies_bindings_partial_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param patched_policy_binding_request:
+ :type patched_policy_binding_request: PatchedPolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_partial_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ patched_policy_binding_request=patched_policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_partial_update_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ patched_policy_binding_request: Optional[PatchedPolicyBindingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_partial_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param patched_policy_binding_request:
+ :type patched_policy_binding_request: PatchedPolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_partial_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ patched_policy_binding_request=patched_policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_partial_update_serialize(
+ self,
+ policy_binding_uuid,
+ patched_policy_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_policy_binding_request is not None:
+ _body_params = patched_policy_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_retrieve(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PolicyBinding:
+ """policies_bindings_retrieve
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_retrieve_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_retrieve_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PolicyBinding]:
+ """policies_bindings_retrieve
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_retrieve_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_retrieve_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_retrieve
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_retrieve_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_retrieve_serialize(
+ self,
+ policy_binding_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_update(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ policy_binding_request: PolicyBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PolicyBinding:
+ """policies_bindings_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param policy_binding_request: (required)
+ :type policy_binding_request: PolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ policy_binding_request=policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_update_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ policy_binding_request: PolicyBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PolicyBinding]:
+ """policies_bindings_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param policy_binding_request: (required)
+ :type policy_binding_request: PolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ policy_binding_request=policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_update_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ policy_binding_request: PolicyBindingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_update
+
+ PolicyBinding Viewset
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param policy_binding_request: (required)
+ :type policy_binding_request: PolicyBindingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_update_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ policy_binding_request=policy_binding_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PolicyBinding",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_update_serialize(
+ self,
+ policy_binding_uuid,
+ policy_binding_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if policy_binding_request is not None:
+ _body_params = policy_binding_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/bindings/{policy_binding_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_bindings_used_by_list(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_used_by_list_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_bindings_used_by_list_with_http_info(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_used_by_list_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_bindings_used_by_list_without_preload_content(
+ self,
+ policy_binding_uuid: Annotated[UUID, Field(description="A UUID string identifying this Policy Binding.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_bindings_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_binding_uuid: A UUID string identifying this Policy Binding. (required)
+ :type policy_binding_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_bindings_used_by_list_serialize(
+ policy_binding_uuid=policy_binding_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_bindings_used_by_list_serialize(
+ self,
+ policy_binding_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_binding_uuid is not None:
+ _path_params['policy_binding_uuid'] = policy_binding_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/bindings/{policy_binding_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_create(
+ self,
+ dummy_policy_request: DummyPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DummyPolicy:
+ """policies_dummy_create
+
+ Dummy Viewset
+
+ :param dummy_policy_request: (required)
+ :type dummy_policy_request: DummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_create_serialize(
+ dummy_policy_request=dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_create_with_http_info(
+ self,
+ dummy_policy_request: DummyPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DummyPolicy]:
+ """policies_dummy_create
+
+ Dummy Viewset
+
+ :param dummy_policy_request: (required)
+ :type dummy_policy_request: DummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_create_serialize(
+ dummy_policy_request=dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_create_without_preload_content(
+ self,
+ dummy_policy_request: DummyPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_create
+
+ Dummy Viewset
+
+ :param dummy_policy_request: (required)
+ :type dummy_policy_request: DummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_create_serialize(
+ dummy_policy_request=dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_create_serialize(
+ self,
+ dummy_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if dummy_policy_request is not None:
+ _body_params = dummy_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/dummy/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_dummy_destroy
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_dummy_destroy
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_destroy
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/dummy/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_list(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ result: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ wait_max: Optional[StrictInt] = None,
+ wait_min: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDummyPolicyList:
+ """policies_dummy_list
+
+ Dummy Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param result:
+ :type result: bool
+ :param search: A search term.
+ :type search: str
+ :param wait_max:
+ :type wait_max: int
+ :param wait_min:
+ :type wait_min: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ result=result,
+ search=search,
+ wait_max=wait_max,
+ wait_min=wait_min,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDummyPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_list_with_http_info(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ result: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ wait_max: Optional[StrictInt] = None,
+ wait_min: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDummyPolicyList]:
+ """policies_dummy_list
+
+ Dummy Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param result:
+ :type result: bool
+ :param search: A search term.
+ :type search: str
+ :param wait_max:
+ :type wait_max: int
+ :param wait_min:
+ :type wait_min: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ result=result,
+ search=search,
+ wait_max=wait_max,
+ wait_min=wait_min,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDummyPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_list_without_preload_content(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ result: Optional[StrictBool] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ wait_max: Optional[StrictInt] = None,
+ wait_min: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_list
+
+ Dummy Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param result:
+ :type result: bool
+ :param search: A search term.
+ :type search: str
+ :param wait_max:
+ :type wait_max: int
+ :param wait_min:
+ :type wait_min: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ result=result,
+ search=search,
+ wait_max=wait_max,
+ wait_min=wait_min,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDummyPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_list_serialize(
+ self,
+ created,
+ execution_logging,
+ last_updated,
+ name,
+ ordering,
+ page,
+ page_size,
+ policy_uuid,
+ result,
+ search,
+ wait_max,
+ wait_min,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if result is not None:
+
+ _query_params.append(('result', result))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if wait_max is not None:
+
+ _query_params.append(('wait_max', wait_max))
+
+ if wait_min is not None:
+
+ _query_params.append(('wait_min', wait_min))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/dummy/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ patched_dummy_policy_request: Optional[PatchedDummyPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DummyPolicy:
+ """policies_dummy_partial_update
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_dummy_policy_request:
+ :type patched_dummy_policy_request: PatchedDummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_dummy_policy_request=patched_dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ patched_dummy_policy_request: Optional[PatchedDummyPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DummyPolicy]:
+ """policies_dummy_partial_update
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_dummy_policy_request:
+ :type patched_dummy_policy_request: PatchedDummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_dummy_policy_request=patched_dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ patched_dummy_policy_request: Optional[PatchedDummyPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_partial_update
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_dummy_policy_request:
+ :type patched_dummy_policy_request: PatchedDummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_dummy_policy_request=patched_dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_dummy_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_dummy_policy_request is not None:
+ _body_params = patched_dummy_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/dummy/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DummyPolicy:
+ """policies_dummy_retrieve
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DummyPolicy]:
+ """policies_dummy_retrieve
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_retrieve
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/dummy/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ dummy_policy_request: DummyPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DummyPolicy:
+ """policies_dummy_update
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param dummy_policy_request: (required)
+ :type dummy_policy_request: DummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_update_serialize(
+ policy_uuid=policy_uuid,
+ dummy_policy_request=dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ dummy_policy_request: DummyPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DummyPolicy]:
+ """policies_dummy_update
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param dummy_policy_request: (required)
+ :type dummy_policy_request: DummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_update_serialize(
+ policy_uuid=policy_uuid,
+ dummy_policy_request=dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ dummy_policy_request: DummyPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_update
+
+ Dummy Viewset
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param dummy_policy_request: (required)
+ :type dummy_policy_request: DummyPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_update_serialize(
+ policy_uuid=policy_uuid,
+ dummy_policy_request=dummy_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DummyPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_update_serialize(
+ self,
+ policy_uuid,
+ dummy_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if dummy_policy_request is not None:
+ _body_params = dummy_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/dummy/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_dummy_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_dummy_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_dummy_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_dummy_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_dummy_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Dummy Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_dummy_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Dummy Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_dummy_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_dummy_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/dummy/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_create(
+ self,
+ event_matcher_policy_request: EventMatcherPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EventMatcherPolicy:
+ """policies_event_matcher_create
+
+ Event Matcher Policy Viewset
+
+ :param event_matcher_policy_request: (required)
+ :type event_matcher_policy_request: EventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_create_serialize(
+ event_matcher_policy_request=event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_create_with_http_info(
+ self,
+ event_matcher_policy_request: EventMatcherPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EventMatcherPolicy]:
+ """policies_event_matcher_create
+
+ Event Matcher Policy Viewset
+
+ :param event_matcher_policy_request: (required)
+ :type event_matcher_policy_request: EventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_create_serialize(
+ event_matcher_policy_request=event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_create_without_preload_content(
+ self,
+ event_matcher_policy_request: EventMatcherPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_create
+
+ Event Matcher Policy Viewset
+
+ :param event_matcher_policy_request: (required)
+ :type event_matcher_policy_request: EventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_create_serialize(
+ event_matcher_policy_request=event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_create_serialize(
+ self,
+ event_matcher_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if event_matcher_policy_request is not None:
+ _body_params = event_matcher_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/event_matcher/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_event_matcher_destroy
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_event_matcher_destroy
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_destroy
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/event_matcher/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_list(
+ self,
+ action: Optional[Any] = None,
+ app: Optional[StrictStr] = None,
+ client_ip: Optional[StrictStr] = None,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ model: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ query: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEventMatcherPolicyList:
+ """policies_event_matcher_list
+
+ Event Matcher Policy Viewset
+
+ :param action:
+ :type action: EventActions
+ :param app:
+ :type app: str
+ :param client_ip:
+ :type client_ip: str
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param model:
+ :type model: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param query:
+ :type query: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_list_serialize(
+ action=action,
+ app=app,
+ client_ip=client_ip,
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ model=model,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ query=query,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEventMatcherPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_list_with_http_info(
+ self,
+ action: Optional[Any] = None,
+ app: Optional[StrictStr] = None,
+ client_ip: Optional[StrictStr] = None,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ model: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ query: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEventMatcherPolicyList]:
+ """policies_event_matcher_list
+
+ Event Matcher Policy Viewset
+
+ :param action:
+ :type action: EventActions
+ :param app:
+ :type app: str
+ :param client_ip:
+ :type client_ip: str
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param model:
+ :type model: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param query:
+ :type query: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_list_serialize(
+ action=action,
+ app=app,
+ client_ip=client_ip,
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ model=model,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ query=query,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEventMatcherPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_list_without_preload_content(
+ self,
+ action: Optional[Any] = None,
+ app: Optional[StrictStr] = None,
+ client_ip: Optional[StrictStr] = None,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ model: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ query: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_list
+
+ Event Matcher Policy Viewset
+
+ :param action:
+ :type action: EventActions
+ :param app:
+ :type app: str
+ :param client_ip:
+ :type client_ip: str
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param model:
+ :type model: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param query:
+ :type query: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_list_serialize(
+ action=action,
+ app=app,
+ client_ip=client_ip,
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ model=model,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ query=query,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEventMatcherPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_list_serialize(
+ self,
+ action,
+ app,
+ client_ip,
+ created,
+ execution_logging,
+ last_updated,
+ model,
+ name,
+ ordering,
+ page,
+ page_size,
+ policy_uuid,
+ query,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if action is not None:
+
+ _query_params.append(('action', action.value))
+
+ if app is not None:
+
+ _query_params.append(('app', app))
+
+ if client_ip is not None:
+
+ _query_params.append(('client_ip', client_ip))
+
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if model is not None:
+
+ _query_params.append(('model', model))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if query is not None:
+
+ _query_params.append(('query', query))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/event_matcher/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ patched_event_matcher_policy_request: Optional[PatchedEventMatcherPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EventMatcherPolicy:
+ """policies_event_matcher_partial_update
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_event_matcher_policy_request:
+ :type patched_event_matcher_policy_request: PatchedEventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_event_matcher_policy_request=patched_event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ patched_event_matcher_policy_request: Optional[PatchedEventMatcherPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EventMatcherPolicy]:
+ """policies_event_matcher_partial_update
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_event_matcher_policy_request:
+ :type patched_event_matcher_policy_request: PatchedEventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_event_matcher_policy_request=patched_event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ patched_event_matcher_policy_request: Optional[PatchedEventMatcherPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_partial_update
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_event_matcher_policy_request:
+ :type patched_event_matcher_policy_request: PatchedEventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_event_matcher_policy_request=patched_event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_event_matcher_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_event_matcher_policy_request is not None:
+ _body_params = patched_event_matcher_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/event_matcher/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EventMatcherPolicy:
+ """policies_event_matcher_retrieve
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EventMatcherPolicy]:
+ """policies_event_matcher_retrieve
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_retrieve
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/event_matcher/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ event_matcher_policy_request: EventMatcherPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> EventMatcherPolicy:
+ """policies_event_matcher_update
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param event_matcher_policy_request: (required)
+ :type event_matcher_policy_request: EventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_update_serialize(
+ policy_uuid=policy_uuid,
+ event_matcher_policy_request=event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ event_matcher_policy_request: EventMatcherPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[EventMatcherPolicy]:
+ """policies_event_matcher_update
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param event_matcher_policy_request: (required)
+ :type event_matcher_policy_request: EventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_update_serialize(
+ policy_uuid=policy_uuid,
+ event_matcher_policy_request=event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ event_matcher_policy_request: EventMatcherPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_update
+
+ Event Matcher Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param event_matcher_policy_request: (required)
+ :type event_matcher_policy_request: EventMatcherPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_update_serialize(
+ policy_uuid=policy_uuid,
+ event_matcher_policy_request=event_matcher_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "EventMatcherPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_update_serialize(
+ self,
+ policy_uuid,
+ event_matcher_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if event_matcher_policy_request is not None:
+ _body_params = event_matcher_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/event_matcher/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_event_matcher_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_event_matcher_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_event_matcher_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_event_matcher_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_event_matcher_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Event Matcher Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_event_matcher_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Event Matcher Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_event_matcher_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_event_matcher_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/event_matcher/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_create(
+ self,
+ expression_policy_request: ExpressionPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ExpressionPolicy:
+ """policies_expression_create
+
+ Source Viewset
+
+ :param expression_policy_request: (required)
+ :type expression_policy_request: ExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_create_serialize(
+ expression_policy_request=expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_create_with_http_info(
+ self,
+ expression_policy_request: ExpressionPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ExpressionPolicy]:
+ """policies_expression_create
+
+ Source Viewset
+
+ :param expression_policy_request: (required)
+ :type expression_policy_request: ExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_create_serialize(
+ expression_policy_request=expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_create_without_preload_content(
+ self,
+ expression_policy_request: ExpressionPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_create
+
+ Source Viewset
+
+ :param expression_policy_request: (required)
+ :type expression_policy_request: ExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_create_serialize(
+ expression_policy_request=expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_create_serialize(
+ self,
+ expression_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if expression_policy_request is not None:
+ _body_params = expression_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/expression/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_expression_destroy
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_expression_destroy
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_destroy
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/expression/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_list(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ expression: Optional[StrictStr] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedExpressionPolicyList:
+ """policies_expression_list
+
+ Source Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param expression:
+ :type expression: str
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ expression=expression,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExpressionPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_list_with_http_info(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ expression: Optional[StrictStr] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedExpressionPolicyList]:
+ """policies_expression_list
+
+ Source Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param expression:
+ :type expression: str
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ expression=expression,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExpressionPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_list_without_preload_content(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ expression: Optional[StrictStr] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_list
+
+ Source Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param expression:
+ :type expression: str
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ expression=expression,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExpressionPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_list_serialize(
+ self,
+ created,
+ execution_logging,
+ expression,
+ last_updated,
+ name,
+ ordering,
+ page,
+ page_size,
+ policy_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if expression is not None:
+
+ _query_params.append(('expression', expression))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/expression/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ patched_expression_policy_request: Optional[PatchedExpressionPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ExpressionPolicy:
+ """policies_expression_partial_update
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_expression_policy_request:
+ :type patched_expression_policy_request: PatchedExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_expression_policy_request=patched_expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ patched_expression_policy_request: Optional[PatchedExpressionPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ExpressionPolicy]:
+ """policies_expression_partial_update
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_expression_policy_request:
+ :type patched_expression_policy_request: PatchedExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_expression_policy_request=patched_expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ patched_expression_policy_request: Optional[PatchedExpressionPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_partial_update
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_expression_policy_request:
+ :type patched_expression_policy_request: PatchedExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_expression_policy_request=patched_expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_expression_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_expression_policy_request is not None:
+ _body_params = patched_expression_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/expression/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ExpressionPolicy:
+ """policies_expression_retrieve
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ExpressionPolicy]:
+ """policies_expression_retrieve
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_retrieve
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/expression/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ expression_policy_request: ExpressionPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ExpressionPolicy:
+ """policies_expression_update
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param expression_policy_request: (required)
+ :type expression_policy_request: ExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_update_serialize(
+ policy_uuid=policy_uuid,
+ expression_policy_request=expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ expression_policy_request: ExpressionPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ExpressionPolicy]:
+ """policies_expression_update
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param expression_policy_request: (required)
+ :type expression_policy_request: ExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_update_serialize(
+ policy_uuid=policy_uuid,
+ expression_policy_request=expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ expression_policy_request: ExpressionPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_update
+
+ Source Viewset
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param expression_policy_request: (required)
+ :type expression_policy_request: ExpressionPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_update_serialize(
+ policy_uuid=policy_uuid,
+ expression_policy_request=expression_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ExpressionPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_update_serialize(
+ self,
+ policy_uuid,
+ expression_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if expression_policy_request is not None:
+ _body_params = expression_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/expression/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_expression_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_expression_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_expression_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_expression_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_expression_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Expression Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_expression_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Expression Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_expression_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_expression_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/expression/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_create(
+ self,
+ geo_ip_policy_request: GeoIPPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GeoIPPolicy:
+ """policies_geoip_create
+
+ GeoIP Viewset
+
+ :param geo_ip_policy_request: (required)
+ :type geo_ip_policy_request: GeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_create_serialize(
+ geo_ip_policy_request=geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_create_with_http_info(
+ self,
+ geo_ip_policy_request: GeoIPPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GeoIPPolicy]:
+ """policies_geoip_create
+
+ GeoIP Viewset
+
+ :param geo_ip_policy_request: (required)
+ :type geo_ip_policy_request: GeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_create_serialize(
+ geo_ip_policy_request=geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_create_without_preload_content(
+ self,
+ geo_ip_policy_request: GeoIPPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_create
+
+ GeoIP Viewset
+
+ :param geo_ip_policy_request: (required)
+ :type geo_ip_policy_request: GeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_create_serialize(
+ geo_ip_policy_request=geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_create_serialize(
+ self,
+ geo_ip_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if geo_ip_policy_request is not None:
+ _body_params = geo_ip_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/geoip/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_geoip_destroy
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_geoip_destroy
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_destroy
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/geoip/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_iso3166_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[DetailedCountry]:
+ """policies_geoip_iso3166_list
+
+ Get all countries in ISO-3166-1
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_iso3166_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[DetailedCountry]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_iso3166_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[DetailedCountry]]:
+ """policies_geoip_iso3166_list
+
+ Get all countries in ISO-3166-1
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_iso3166_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[DetailedCountry]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_iso3166_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_iso3166_list
+
+ Get all countries in ISO-3166-1
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_iso3166_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[DetailedCountry]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_iso3166_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/geoip_iso3166/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGeoIPPolicyList:
+ """policies_geoip_list
+
+ GeoIP Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGeoIPPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGeoIPPolicyList]:
+ """policies_geoip_list
+
+ GeoIP Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGeoIPPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_list
+
+ GeoIP Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGeoIPPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/geoip/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ patched_geo_ip_policy_request: Optional[PatchedGeoIPPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GeoIPPolicy:
+ """policies_geoip_partial_update
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_geo_ip_policy_request:
+ :type patched_geo_ip_policy_request: PatchedGeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_geo_ip_policy_request=patched_geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ patched_geo_ip_policy_request: Optional[PatchedGeoIPPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GeoIPPolicy]:
+ """policies_geoip_partial_update
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_geo_ip_policy_request:
+ :type patched_geo_ip_policy_request: PatchedGeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_geo_ip_policy_request=patched_geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ patched_geo_ip_policy_request: Optional[PatchedGeoIPPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_partial_update
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_geo_ip_policy_request:
+ :type patched_geo_ip_policy_request: PatchedGeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_geo_ip_policy_request=patched_geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_geo_ip_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_geo_ip_policy_request is not None:
+ _body_params = patched_geo_ip_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/geoip/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GeoIPPolicy:
+ """policies_geoip_retrieve
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GeoIPPolicy]:
+ """policies_geoip_retrieve
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_retrieve
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/geoip/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ geo_ip_policy_request: GeoIPPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GeoIPPolicy:
+ """policies_geoip_update
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param geo_ip_policy_request: (required)
+ :type geo_ip_policy_request: GeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_update_serialize(
+ policy_uuid=policy_uuid,
+ geo_ip_policy_request=geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ geo_ip_policy_request: GeoIPPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GeoIPPolicy]:
+ """policies_geoip_update
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param geo_ip_policy_request: (required)
+ :type geo_ip_policy_request: GeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_update_serialize(
+ policy_uuid=policy_uuid,
+ geo_ip_policy_request=geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ geo_ip_policy_request: GeoIPPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_update
+
+ GeoIP Viewset
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param geo_ip_policy_request: (required)
+ :type geo_ip_policy_request: GeoIPPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_update_serialize(
+ policy_uuid=policy_uuid,
+ geo_ip_policy_request=geo_ip_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GeoIPPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_update_serialize(
+ self,
+ policy_uuid,
+ geo_ip_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if geo_ip_policy_request is not None:
+ _body_params = geo_ip_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/geoip/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_geoip_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_geoip_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_geoip_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_geoip_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_geoip_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this GeoIP Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_geoip_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this GeoIP Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_geoip_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_geoip_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/geoip/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_create(
+ self,
+ password_policy_request: PasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordPolicy:
+ """policies_password_create
+
+ Password Policy Viewset
+
+ :param password_policy_request: (required)
+ :type password_policy_request: PasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_create_serialize(
+ password_policy_request=password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_create_with_http_info(
+ self,
+ password_policy_request: PasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordPolicy]:
+ """policies_password_create
+
+ Password Policy Viewset
+
+ :param password_policy_request: (required)
+ :type password_policy_request: PasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_create_serialize(
+ password_policy_request=password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_create_without_preload_content(
+ self,
+ password_policy_request: PasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_create
+
+ Password Policy Viewset
+
+ :param password_policy_request: (required)
+ :type password_policy_request: PasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_create_serialize(
+ password_policy_request=password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_create_serialize(
+ self,
+ password_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if password_policy_request is not None:
+ _body_params = password_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/password/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_password_destroy
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_password_destroy
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_destroy
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_create(
+ self,
+ password_expiry_policy_request: PasswordExpiryPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordExpiryPolicy:
+ """policies_password_expiry_create
+
+ Password Expiry Viewset
+
+ :param password_expiry_policy_request: (required)
+ :type password_expiry_policy_request: PasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_create_serialize(
+ password_expiry_policy_request=password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_create_with_http_info(
+ self,
+ password_expiry_policy_request: PasswordExpiryPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordExpiryPolicy]:
+ """policies_password_expiry_create
+
+ Password Expiry Viewset
+
+ :param password_expiry_policy_request: (required)
+ :type password_expiry_policy_request: PasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_create_serialize(
+ password_expiry_policy_request=password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_create_without_preload_content(
+ self,
+ password_expiry_policy_request: PasswordExpiryPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_create
+
+ Password Expiry Viewset
+
+ :param password_expiry_policy_request: (required)
+ :type password_expiry_policy_request: PasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_create_serialize(
+ password_expiry_policy_request=password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_create_serialize(
+ self,
+ password_expiry_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if password_expiry_policy_request is not None:
+ _body_params = password_expiry_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/password_expiry/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_password_expiry_destroy
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_password_expiry_destroy
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_destroy
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/password_expiry/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_list(
+ self,
+ created: Optional[datetime] = None,
+ days: Optional[StrictInt] = None,
+ deny_only: Optional[StrictBool] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPasswordExpiryPolicyList:
+ """policies_password_expiry_list
+
+ Password Expiry Viewset
+
+ :param created:
+ :type created: datetime
+ :param days:
+ :type days: int
+ :param deny_only:
+ :type deny_only: bool
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_list_serialize(
+ created=created,
+ days=days,
+ deny_only=deny_only,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPasswordExpiryPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_list_with_http_info(
+ self,
+ created: Optional[datetime] = None,
+ days: Optional[StrictInt] = None,
+ deny_only: Optional[StrictBool] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPasswordExpiryPolicyList]:
+ """policies_password_expiry_list
+
+ Password Expiry Viewset
+
+ :param created:
+ :type created: datetime
+ :param days:
+ :type days: int
+ :param deny_only:
+ :type deny_only: bool
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_list_serialize(
+ created=created,
+ days=days,
+ deny_only=deny_only,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPasswordExpiryPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_list_without_preload_content(
+ self,
+ created: Optional[datetime] = None,
+ days: Optional[StrictInt] = None,
+ deny_only: Optional[StrictBool] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_list
+
+ Password Expiry Viewset
+
+ :param created:
+ :type created: datetime
+ :param days:
+ :type days: int
+ :param deny_only:
+ :type deny_only: bool
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_list_serialize(
+ created=created,
+ days=days,
+ deny_only=deny_only,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPasswordExpiryPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_list_serialize(
+ self,
+ created,
+ days,
+ deny_only,
+ execution_logging,
+ last_updated,
+ name,
+ ordering,
+ page,
+ page_size,
+ policy_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if days is not None:
+
+ _query_params.append(('days', days))
+
+ if deny_only is not None:
+
+ _query_params.append(('deny_only', deny_only))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/password_expiry/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ patched_password_expiry_policy_request: Optional[PatchedPasswordExpiryPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordExpiryPolicy:
+ """policies_password_expiry_partial_update
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_password_expiry_policy_request:
+ :type patched_password_expiry_policy_request: PatchedPasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_password_expiry_policy_request=patched_password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ patched_password_expiry_policy_request: Optional[PatchedPasswordExpiryPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordExpiryPolicy]:
+ """policies_password_expiry_partial_update
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_password_expiry_policy_request:
+ :type patched_password_expiry_policy_request: PatchedPasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_password_expiry_policy_request=patched_password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ patched_password_expiry_policy_request: Optional[PatchedPasswordExpiryPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_partial_update
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_password_expiry_policy_request:
+ :type patched_password_expiry_policy_request: PatchedPasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_password_expiry_policy_request=patched_password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_password_expiry_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_password_expiry_policy_request is not None:
+ _body_params = patched_password_expiry_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/password_expiry/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordExpiryPolicy:
+ """policies_password_expiry_retrieve
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordExpiryPolicy]:
+ """policies_password_expiry_retrieve
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_retrieve
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/password_expiry/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ password_expiry_policy_request: PasswordExpiryPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordExpiryPolicy:
+ """policies_password_expiry_update
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param password_expiry_policy_request: (required)
+ :type password_expiry_policy_request: PasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_update_serialize(
+ policy_uuid=policy_uuid,
+ password_expiry_policy_request=password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ password_expiry_policy_request: PasswordExpiryPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordExpiryPolicy]:
+ """policies_password_expiry_update
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param password_expiry_policy_request: (required)
+ :type password_expiry_policy_request: PasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_update_serialize(
+ policy_uuid=policy_uuid,
+ password_expiry_policy_request=password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ password_expiry_policy_request: PasswordExpiryPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_update
+
+ Password Expiry Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param password_expiry_policy_request: (required)
+ :type password_expiry_policy_request: PasswordExpiryPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_update_serialize(
+ policy_uuid=policy_uuid,
+ password_expiry_policy_request=password_expiry_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordExpiryPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_update_serialize(
+ self,
+ policy_uuid,
+ password_expiry_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if password_expiry_policy_request is not None:
+ _body_params = password_expiry_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/password_expiry/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_expiry_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_password_expiry_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_expiry_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_password_expiry_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_expiry_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Expiry Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_expiry_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Expiry Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_expiry_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_expiry_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/password_expiry/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_list(
+ self,
+ amount_digits: Optional[StrictInt] = None,
+ amount_lowercase: Optional[StrictInt] = None,
+ amount_symbols: Optional[StrictInt] = None,
+ amount_uppercase: Optional[StrictInt] = None,
+ check_have_i_been_pwned: Optional[StrictBool] = None,
+ check_static_rules: Optional[StrictBool] = None,
+ check_zxcvbn: Optional[StrictBool] = None,
+ created: Optional[datetime] = None,
+ error_message: Optional[StrictStr] = None,
+ execution_logging: Optional[StrictBool] = None,
+ hibp_allowed_count: Optional[StrictInt] = None,
+ last_updated: Optional[datetime] = None,
+ length_min: Optional[StrictInt] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ password_field: Optional[StrictStr] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ symbol_charset: Optional[StrictStr] = None,
+ zxcvbn_score_threshold: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPasswordPolicyList:
+ """policies_password_list
+
+ Password Policy Viewset
+
+ :param amount_digits:
+ :type amount_digits: int
+ :param amount_lowercase:
+ :type amount_lowercase: int
+ :param amount_symbols:
+ :type amount_symbols: int
+ :param amount_uppercase:
+ :type amount_uppercase: int
+ :param check_have_i_been_pwned:
+ :type check_have_i_been_pwned: bool
+ :param check_static_rules:
+ :type check_static_rules: bool
+ :param check_zxcvbn:
+ :type check_zxcvbn: bool
+ :param created:
+ :type created: datetime
+ :param error_message:
+ :type error_message: str
+ :param execution_logging:
+ :type execution_logging: bool
+ :param hibp_allowed_count:
+ :type hibp_allowed_count: int
+ :param last_updated:
+ :type last_updated: datetime
+ :param length_min:
+ :type length_min: int
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param password_field:
+ :type password_field: str
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param symbol_charset:
+ :type symbol_charset: str
+ :param zxcvbn_score_threshold:
+ :type zxcvbn_score_threshold: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_list_serialize(
+ amount_digits=amount_digits,
+ amount_lowercase=amount_lowercase,
+ amount_symbols=amount_symbols,
+ amount_uppercase=amount_uppercase,
+ check_have_i_been_pwned=check_have_i_been_pwned,
+ check_static_rules=check_static_rules,
+ check_zxcvbn=check_zxcvbn,
+ created=created,
+ error_message=error_message,
+ execution_logging=execution_logging,
+ hibp_allowed_count=hibp_allowed_count,
+ last_updated=last_updated,
+ length_min=length_min,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ password_field=password_field,
+ policy_uuid=policy_uuid,
+ search=search,
+ symbol_charset=symbol_charset,
+ zxcvbn_score_threshold=zxcvbn_score_threshold,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPasswordPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_list_with_http_info(
+ self,
+ amount_digits: Optional[StrictInt] = None,
+ amount_lowercase: Optional[StrictInt] = None,
+ amount_symbols: Optional[StrictInt] = None,
+ amount_uppercase: Optional[StrictInt] = None,
+ check_have_i_been_pwned: Optional[StrictBool] = None,
+ check_static_rules: Optional[StrictBool] = None,
+ check_zxcvbn: Optional[StrictBool] = None,
+ created: Optional[datetime] = None,
+ error_message: Optional[StrictStr] = None,
+ execution_logging: Optional[StrictBool] = None,
+ hibp_allowed_count: Optional[StrictInt] = None,
+ last_updated: Optional[datetime] = None,
+ length_min: Optional[StrictInt] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ password_field: Optional[StrictStr] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ symbol_charset: Optional[StrictStr] = None,
+ zxcvbn_score_threshold: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPasswordPolicyList]:
+ """policies_password_list
+
+ Password Policy Viewset
+
+ :param amount_digits:
+ :type amount_digits: int
+ :param amount_lowercase:
+ :type amount_lowercase: int
+ :param amount_symbols:
+ :type amount_symbols: int
+ :param amount_uppercase:
+ :type amount_uppercase: int
+ :param check_have_i_been_pwned:
+ :type check_have_i_been_pwned: bool
+ :param check_static_rules:
+ :type check_static_rules: bool
+ :param check_zxcvbn:
+ :type check_zxcvbn: bool
+ :param created:
+ :type created: datetime
+ :param error_message:
+ :type error_message: str
+ :param execution_logging:
+ :type execution_logging: bool
+ :param hibp_allowed_count:
+ :type hibp_allowed_count: int
+ :param last_updated:
+ :type last_updated: datetime
+ :param length_min:
+ :type length_min: int
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param password_field:
+ :type password_field: str
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param symbol_charset:
+ :type symbol_charset: str
+ :param zxcvbn_score_threshold:
+ :type zxcvbn_score_threshold: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_list_serialize(
+ amount_digits=amount_digits,
+ amount_lowercase=amount_lowercase,
+ amount_symbols=amount_symbols,
+ amount_uppercase=amount_uppercase,
+ check_have_i_been_pwned=check_have_i_been_pwned,
+ check_static_rules=check_static_rules,
+ check_zxcvbn=check_zxcvbn,
+ created=created,
+ error_message=error_message,
+ execution_logging=execution_logging,
+ hibp_allowed_count=hibp_allowed_count,
+ last_updated=last_updated,
+ length_min=length_min,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ password_field=password_field,
+ policy_uuid=policy_uuid,
+ search=search,
+ symbol_charset=symbol_charset,
+ zxcvbn_score_threshold=zxcvbn_score_threshold,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPasswordPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_list_without_preload_content(
+ self,
+ amount_digits: Optional[StrictInt] = None,
+ amount_lowercase: Optional[StrictInt] = None,
+ amount_symbols: Optional[StrictInt] = None,
+ amount_uppercase: Optional[StrictInt] = None,
+ check_have_i_been_pwned: Optional[StrictBool] = None,
+ check_static_rules: Optional[StrictBool] = None,
+ check_zxcvbn: Optional[StrictBool] = None,
+ created: Optional[datetime] = None,
+ error_message: Optional[StrictStr] = None,
+ execution_logging: Optional[StrictBool] = None,
+ hibp_allowed_count: Optional[StrictInt] = None,
+ last_updated: Optional[datetime] = None,
+ length_min: Optional[StrictInt] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ password_field: Optional[StrictStr] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ symbol_charset: Optional[StrictStr] = None,
+ zxcvbn_score_threshold: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_list
+
+ Password Policy Viewset
+
+ :param amount_digits:
+ :type amount_digits: int
+ :param amount_lowercase:
+ :type amount_lowercase: int
+ :param amount_symbols:
+ :type amount_symbols: int
+ :param amount_uppercase:
+ :type amount_uppercase: int
+ :param check_have_i_been_pwned:
+ :type check_have_i_been_pwned: bool
+ :param check_static_rules:
+ :type check_static_rules: bool
+ :param check_zxcvbn:
+ :type check_zxcvbn: bool
+ :param created:
+ :type created: datetime
+ :param error_message:
+ :type error_message: str
+ :param execution_logging:
+ :type execution_logging: bool
+ :param hibp_allowed_count:
+ :type hibp_allowed_count: int
+ :param last_updated:
+ :type last_updated: datetime
+ :param length_min:
+ :type length_min: int
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param password_field:
+ :type password_field: str
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param symbol_charset:
+ :type symbol_charset: str
+ :param zxcvbn_score_threshold:
+ :type zxcvbn_score_threshold: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_list_serialize(
+ amount_digits=amount_digits,
+ amount_lowercase=amount_lowercase,
+ amount_symbols=amount_symbols,
+ amount_uppercase=amount_uppercase,
+ check_have_i_been_pwned=check_have_i_been_pwned,
+ check_static_rules=check_static_rules,
+ check_zxcvbn=check_zxcvbn,
+ created=created,
+ error_message=error_message,
+ execution_logging=execution_logging,
+ hibp_allowed_count=hibp_allowed_count,
+ last_updated=last_updated,
+ length_min=length_min,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ password_field=password_field,
+ policy_uuid=policy_uuid,
+ search=search,
+ symbol_charset=symbol_charset,
+ zxcvbn_score_threshold=zxcvbn_score_threshold,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPasswordPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_list_serialize(
+ self,
+ amount_digits,
+ amount_lowercase,
+ amount_symbols,
+ amount_uppercase,
+ check_have_i_been_pwned,
+ check_static_rules,
+ check_zxcvbn,
+ created,
+ error_message,
+ execution_logging,
+ hibp_allowed_count,
+ last_updated,
+ length_min,
+ name,
+ ordering,
+ page,
+ page_size,
+ password_field,
+ policy_uuid,
+ search,
+ symbol_charset,
+ zxcvbn_score_threshold,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if amount_digits is not None:
+
+ _query_params.append(('amount_digits', amount_digits))
+
+ if amount_lowercase is not None:
+
+ _query_params.append(('amount_lowercase', amount_lowercase))
+
+ if amount_symbols is not None:
+
+ _query_params.append(('amount_symbols', amount_symbols))
+
+ if amount_uppercase is not None:
+
+ _query_params.append(('amount_uppercase', amount_uppercase))
+
+ if check_have_i_been_pwned is not None:
+
+ _query_params.append(('check_have_i_been_pwned', check_have_i_been_pwned))
+
+ if check_static_rules is not None:
+
+ _query_params.append(('check_static_rules', check_static_rules))
+
+ if check_zxcvbn is not None:
+
+ _query_params.append(('check_zxcvbn', check_zxcvbn))
+
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if error_message is not None:
+
+ _query_params.append(('error_message', error_message))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if hibp_allowed_count is not None:
+
+ _query_params.append(('hibp_allowed_count', hibp_allowed_count))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if length_min is not None:
+
+ _query_params.append(('length_min', length_min))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if password_field is not None:
+
+ _query_params.append(('password_field', password_field))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if symbol_charset is not None:
+
+ _query_params.append(('symbol_charset', symbol_charset))
+
+ if zxcvbn_score_threshold is not None:
+
+ _query_params.append(('zxcvbn_score_threshold', zxcvbn_score_threshold))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/password/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ patched_password_policy_request: Optional[PatchedPasswordPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordPolicy:
+ """policies_password_partial_update
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_password_policy_request:
+ :type patched_password_policy_request: PatchedPasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_password_policy_request=patched_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ patched_password_policy_request: Optional[PatchedPasswordPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordPolicy]:
+ """policies_password_partial_update
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_password_policy_request:
+ :type patched_password_policy_request: PatchedPasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_password_policy_request=patched_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ patched_password_policy_request: Optional[PatchedPasswordPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_partial_update
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_password_policy_request:
+ :type patched_password_policy_request: PatchedPasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_password_policy_request=patched_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_password_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_password_policy_request is not None:
+ _body_params = patched_password_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordPolicy:
+ """policies_password_retrieve
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordPolicy]:
+ """policies_password_retrieve
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_retrieve
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ password_policy_request: PasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PasswordPolicy:
+ """policies_password_update
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param password_policy_request: (required)
+ :type password_policy_request: PasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_update_serialize(
+ policy_uuid=policy_uuid,
+ password_policy_request=password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ password_policy_request: PasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PasswordPolicy]:
+ """policies_password_update
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param password_policy_request: (required)
+ :type password_policy_request: PasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_update_serialize(
+ policy_uuid=policy_uuid,
+ password_policy_request=password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ password_policy_request: PasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_update
+
+ Password Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param password_policy_request: (required)
+ :type password_policy_request: PasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_update_serialize(
+ policy_uuid=policy_uuid,
+ password_policy_request=password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_update_serialize(
+ self,
+ policy_uuid,
+ password_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if password_policy_request is not None:
+ _body_params = password_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_password_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_password_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_password_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_password_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_password_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_password_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_password_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_password_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/password/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_create(
+ self,
+ reputation_policy_request: ReputationPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ReputationPolicy:
+ """policies_reputation_create
+
+ Reputation Policy Viewset
+
+ :param reputation_policy_request: (required)
+ :type reputation_policy_request: ReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_create_serialize(
+ reputation_policy_request=reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_create_with_http_info(
+ self,
+ reputation_policy_request: ReputationPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ReputationPolicy]:
+ """policies_reputation_create
+
+ Reputation Policy Viewset
+
+ :param reputation_policy_request: (required)
+ :type reputation_policy_request: ReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_create_serialize(
+ reputation_policy_request=reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_create_without_preload_content(
+ self,
+ reputation_policy_request: ReputationPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_create
+
+ Reputation Policy Viewset
+
+ :param reputation_policy_request: (required)
+ :type reputation_policy_request: ReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_create_serialize(
+ reputation_policy_request=reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_create_serialize(
+ self,
+ reputation_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if reputation_policy_request is not None:
+ _body_params = reputation_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/reputation/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_reputation_destroy
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_reputation_destroy
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_destroy
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/reputation/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_list(
+ self,
+ check_ip: Optional[StrictBool] = None,
+ check_username: Optional[StrictBool] = None,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ threshold: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedReputationPolicyList:
+ """policies_reputation_list
+
+ Reputation Policy Viewset
+
+ :param check_ip:
+ :type check_ip: bool
+ :param check_username:
+ :type check_username: bool
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param threshold:
+ :type threshold: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_list_serialize(
+ check_ip=check_ip,
+ check_username=check_username,
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ threshold=threshold,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedReputationPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_list_with_http_info(
+ self,
+ check_ip: Optional[StrictBool] = None,
+ check_username: Optional[StrictBool] = None,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ threshold: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedReputationPolicyList]:
+ """policies_reputation_list
+
+ Reputation Policy Viewset
+
+ :param check_ip:
+ :type check_ip: bool
+ :param check_username:
+ :type check_username: bool
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param threshold:
+ :type threshold: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_list_serialize(
+ check_ip=check_ip,
+ check_username=check_username,
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ threshold=threshold,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedReputationPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_list_without_preload_content(
+ self,
+ check_ip: Optional[StrictBool] = None,
+ check_username: Optional[StrictBool] = None,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ threshold: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_list
+
+ Reputation Policy Viewset
+
+ :param check_ip:
+ :type check_ip: bool
+ :param check_username:
+ :type check_username: bool
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param threshold:
+ :type threshold: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_list_serialize(
+ check_ip=check_ip,
+ check_username=check_username,
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ policy_uuid=policy_uuid,
+ search=search,
+ threshold=threshold,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedReputationPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_list_serialize(
+ self,
+ check_ip,
+ check_username,
+ created,
+ execution_logging,
+ last_updated,
+ name,
+ ordering,
+ page,
+ page_size,
+ policy_uuid,
+ search,
+ threshold,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if check_ip is not None:
+
+ _query_params.append(('check_ip', check_ip))
+
+ if check_username is not None:
+
+ _query_params.append(('check_username', check_username))
+
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if threshold is not None:
+
+ _query_params.append(('threshold', threshold))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/reputation/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ patched_reputation_policy_request: Optional[PatchedReputationPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ReputationPolicy:
+ """policies_reputation_partial_update
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_reputation_policy_request:
+ :type patched_reputation_policy_request: PatchedReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_reputation_policy_request=patched_reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ patched_reputation_policy_request: Optional[PatchedReputationPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ReputationPolicy]:
+ """policies_reputation_partial_update
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_reputation_policy_request:
+ :type patched_reputation_policy_request: PatchedReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_reputation_policy_request=patched_reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ patched_reputation_policy_request: Optional[PatchedReputationPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_partial_update
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_reputation_policy_request:
+ :type patched_reputation_policy_request: PatchedReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_reputation_policy_request=patched_reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_reputation_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_reputation_policy_request is not None:
+ _body_params = patched_reputation_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/reputation/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ReputationPolicy:
+ """policies_reputation_retrieve
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ReputationPolicy]:
+ """policies_reputation_retrieve
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_retrieve
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/reputation/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_scores_destroy(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_reputation_scores_destroy
+
+ Reputation Viewset
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_destroy_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_scores_destroy_with_http_info(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_reputation_scores_destroy
+
+ Reputation Viewset
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_destroy_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_scores_destroy_without_preload_content(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_scores_destroy
+
+ Reputation Viewset
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_destroy_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_scores_destroy_serialize(
+ self,
+ reputation_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if reputation_uuid is not None:
+ _path_params['reputation_uuid'] = reputation_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/reputation/scores/{reputation_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_scores_list(
+ self,
+ identifier: Optional[StrictStr] = None,
+ identifier_in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
+ ip: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ score: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedReputationList:
+ """policies_reputation_scores_list
+
+ Reputation Viewset
+
+ :param identifier:
+ :type identifier: str
+ :param identifier_in: Multiple values may be separated by commas.
+ :type identifier_in: List[str]
+ :param ip:
+ :type ip: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param score:
+ :type score: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_list_serialize(
+ identifier=identifier,
+ identifier_in=identifier_in,
+ ip=ip,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ score=score,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedReputationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_scores_list_with_http_info(
+ self,
+ identifier: Optional[StrictStr] = None,
+ identifier_in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
+ ip: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ score: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedReputationList]:
+ """policies_reputation_scores_list
+
+ Reputation Viewset
+
+ :param identifier:
+ :type identifier: str
+ :param identifier_in: Multiple values may be separated by commas.
+ :type identifier_in: List[str]
+ :param ip:
+ :type ip: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param score:
+ :type score: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_list_serialize(
+ identifier=identifier,
+ identifier_in=identifier_in,
+ ip=ip,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ score=score,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedReputationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_scores_list_without_preload_content(
+ self,
+ identifier: Optional[StrictStr] = None,
+ identifier_in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
+ ip: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ score: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_scores_list
+
+ Reputation Viewset
+
+ :param identifier:
+ :type identifier: str
+ :param identifier_in: Multiple values may be separated by commas.
+ :type identifier_in: List[str]
+ :param ip:
+ :type ip: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param score:
+ :type score: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_list_serialize(
+ identifier=identifier,
+ identifier_in=identifier_in,
+ ip=ip,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ score=score,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedReputationList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_scores_list_serialize(
+ self,
+ identifier,
+ identifier_in,
+ ip,
+ ordering,
+ page,
+ page_size,
+ score,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'identifier_in': 'csv',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if identifier is not None:
+
+ _query_params.append(('identifier', identifier))
+
+ if identifier_in is not None:
+
+ _query_params.append(('identifier_in', identifier_in))
+
+ if ip is not None:
+
+ _query_params.append(('ip', ip))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if score is not None:
+
+ _query_params.append(('score', score))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/reputation/scores/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_scores_retrieve(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Reputation:
+ """policies_reputation_scores_retrieve
+
+ Reputation Viewset
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_retrieve_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Reputation",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_scores_retrieve_with_http_info(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Reputation]:
+ """policies_reputation_scores_retrieve
+
+ Reputation Viewset
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_retrieve_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Reputation",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_scores_retrieve_without_preload_content(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_scores_retrieve
+
+ Reputation Viewset
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_retrieve_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Reputation",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_scores_retrieve_serialize(
+ self,
+ reputation_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if reputation_uuid is not None:
+ _path_params['reputation_uuid'] = reputation_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/reputation/scores/{reputation_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_scores_used_by_list(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_reputation_scores_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_used_by_list_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_scores_used_by_list_with_http_info(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_reputation_scores_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_used_by_list_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_scores_used_by_list_without_preload_content(
+ self,
+ reputation_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Score.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_scores_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param reputation_uuid: A UUID string identifying this Reputation Score. (required)
+ :type reputation_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_scores_used_by_list_serialize(
+ reputation_uuid=reputation_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_scores_used_by_list_serialize(
+ self,
+ reputation_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if reputation_uuid is not None:
+ _path_params['reputation_uuid'] = reputation_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/reputation/scores/{reputation_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ reputation_policy_request: ReputationPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ReputationPolicy:
+ """policies_reputation_update
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param reputation_policy_request: (required)
+ :type reputation_policy_request: ReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_update_serialize(
+ policy_uuid=policy_uuid,
+ reputation_policy_request=reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ reputation_policy_request: ReputationPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ReputationPolicy]:
+ """policies_reputation_update
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param reputation_policy_request: (required)
+ :type reputation_policy_request: ReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_update_serialize(
+ policy_uuid=policy_uuid,
+ reputation_policy_request=reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ reputation_policy_request: ReputationPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_update
+
+ Reputation Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param reputation_policy_request: (required)
+ :type reputation_policy_request: ReputationPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_update_serialize(
+ policy_uuid=policy_uuid,
+ reputation_policy_request=reputation_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ReputationPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_update_serialize(
+ self,
+ policy_uuid,
+ reputation_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if reputation_policy_request is not None:
+ _body_params = reputation_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/reputation/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_reputation_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_reputation_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_reputation_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_reputation_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_reputation_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Reputation Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_reputation_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Reputation Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_reputation_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_reputation_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/reputation/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_create(
+ self,
+ unique_password_policy_request: UniquePasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UniquePasswordPolicy:
+ """policies_unique_password_create
+
+ Password Uniqueness Policy Viewset
+
+ :param unique_password_policy_request: (required)
+ :type unique_password_policy_request: UniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_create_serialize(
+ unique_password_policy_request=unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_create_with_http_info(
+ self,
+ unique_password_policy_request: UniquePasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UniquePasswordPolicy]:
+ """policies_unique_password_create
+
+ Password Uniqueness Policy Viewset
+
+ :param unique_password_policy_request: (required)
+ :type unique_password_policy_request: UniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_create_serialize(
+ unique_password_policy_request=unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_create_without_preload_content(
+ self,
+ unique_password_policy_request: UniquePasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_create
+
+ Password Uniqueness Policy Viewset
+
+ :param unique_password_policy_request: (required)
+ :type unique_password_policy_request: UniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_create_serialize(
+ unique_password_policy_request=unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_create_serialize(
+ self,
+ unique_password_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if unique_password_policy_request is not None:
+ _body_params = unique_password_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/policies/unique_password/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_destroy(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """policies_unique_password_destroy
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_destroy_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """policies_unique_password_destroy
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_destroy_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_destroy
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_destroy_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_destroy_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/policies/unique_password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_list(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ num_historical_passwords: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ password_field: Optional[StrictStr] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedUniquePasswordPolicyList:
+ """policies_unique_password_list
+
+ Password Uniqueness Policy Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param num_historical_passwords:
+ :type num_historical_passwords: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param password_field:
+ :type password_field: str
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ num_historical_passwords=num_historical_passwords,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ password_field=password_field,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUniquePasswordPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_list_with_http_info(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ num_historical_passwords: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ password_field: Optional[StrictStr] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedUniquePasswordPolicyList]:
+ """policies_unique_password_list
+
+ Password Uniqueness Policy Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param num_historical_passwords:
+ :type num_historical_passwords: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param password_field:
+ :type password_field: str
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ num_historical_passwords=num_historical_passwords,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ password_field=password_field,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUniquePasswordPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_list_without_preload_content(
+ self,
+ created: Optional[datetime] = None,
+ execution_logging: Optional[StrictBool] = None,
+ last_updated: Optional[datetime] = None,
+ name: Optional[StrictStr] = None,
+ num_historical_passwords: Optional[StrictInt] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ password_field: Optional[StrictStr] = None,
+ policy_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_list
+
+ Password Uniqueness Policy Viewset
+
+ :param created:
+ :type created: datetime
+ :param execution_logging:
+ :type execution_logging: bool
+ :param last_updated:
+ :type last_updated: datetime
+ :param name:
+ :type name: str
+ :param num_historical_passwords:
+ :type num_historical_passwords: int
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param password_field:
+ :type password_field: str
+ :param policy_uuid:
+ :type policy_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_list_serialize(
+ created=created,
+ execution_logging=execution_logging,
+ last_updated=last_updated,
+ name=name,
+ num_historical_passwords=num_historical_passwords,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ password_field=password_field,
+ policy_uuid=policy_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedUniquePasswordPolicyList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_list_serialize(
+ self,
+ created,
+ execution_logging,
+ last_updated,
+ name,
+ num_historical_passwords,
+ ordering,
+ page,
+ page_size,
+ password_field,
+ policy_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if created is not None:
+ if isinstance(created, datetime):
+ _query_params.append(
+ (
+ 'created',
+ created.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('created', created))
+
+ if execution_logging is not None:
+
+ _query_params.append(('execution_logging', execution_logging))
+
+ if last_updated is not None:
+ if isinstance(last_updated, datetime):
+ _query_params.append(
+ (
+ 'last_updated',
+ last_updated.strftime(
+ self.api_client.configuration.datetime_format
+ )
+ )
+ )
+ else:
+ _query_params.append(('last_updated', last_updated))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if num_historical_passwords is not None:
+
+ _query_params.append(('num_historical_passwords', num_historical_passwords))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if password_field is not None:
+
+ _query_params.append(('password_field', password_field))
+
+ if policy_uuid is not None:
+
+ _query_params.append(('policy_uuid', policy_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/unique_password/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_partial_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ patched_unique_password_policy_request: Optional[PatchedUniquePasswordPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UniquePasswordPolicy:
+ """policies_unique_password_partial_update
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_unique_password_policy_request:
+ :type patched_unique_password_policy_request: PatchedUniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_unique_password_policy_request=patched_unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_partial_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ patched_unique_password_policy_request: Optional[PatchedUniquePasswordPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UniquePasswordPolicy]:
+ """policies_unique_password_partial_update
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_unique_password_policy_request:
+ :type patched_unique_password_policy_request: PatchedUniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_unique_password_policy_request=patched_unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_partial_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ patched_unique_password_policy_request: Optional[PatchedUniquePasswordPolicyRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_partial_update
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param patched_unique_password_policy_request:
+ :type patched_unique_password_policy_request: PatchedUniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_partial_update_serialize(
+ policy_uuid=policy_uuid,
+ patched_unique_password_policy_request=patched_unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_partial_update_serialize(
+ self,
+ policy_uuid,
+ patched_unique_password_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_unique_password_policy_request is not None:
+ _body_params = patched_unique_password_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/policies/unique_password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_retrieve(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UniquePasswordPolicy:
+ """policies_unique_password_retrieve
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_retrieve_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UniquePasswordPolicy]:
+ """policies_unique_password_retrieve
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_retrieve_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_retrieve
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_retrieve_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_retrieve_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/unique_password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_update(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ unique_password_policy_request: UniquePasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> UniquePasswordPolicy:
+ """policies_unique_password_update
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param unique_password_policy_request: (required)
+ :type unique_password_policy_request: UniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_update_serialize(
+ policy_uuid=policy_uuid,
+ unique_password_policy_request=unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_update_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ unique_password_policy_request: UniquePasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[UniquePasswordPolicy]:
+ """policies_unique_password_update
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param unique_password_policy_request: (required)
+ :type unique_password_policy_request: UniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_update_serialize(
+ policy_uuid=policy_uuid,
+ unique_password_policy_request=unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_update_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ unique_password_policy_request: UniquePasswordPolicyRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_update
+
+ Password Uniqueness Policy Viewset
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param unique_password_policy_request: (required)
+ :type unique_password_policy_request: UniquePasswordPolicyRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_update_serialize(
+ policy_uuid=policy_uuid,
+ unique_password_policy_request=unique_password_policy_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "UniquePasswordPolicy",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_update_serialize(
+ self,
+ policy_uuid,
+ unique_password_policy_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if unique_password_policy_request is not None:
+ _body_params = unique_password_policy_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/policies/unique_password/{policy_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def policies_unique_password_used_by_list(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """policies_unique_password_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def policies_unique_password_used_by_list_with_http_info(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """policies_unique_password_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def policies_unique_password_used_by_list_without_preload_content(
+ self,
+ policy_uuid: Annotated[UUID, Field(description="A UUID string identifying this Password Uniqueness Policy.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """policies_unique_password_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param policy_uuid: A UUID string identifying this Password Uniqueness Policy. (required)
+ :type policy_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._policies_unique_password_used_by_list_serialize(
+ policy_uuid=policy_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _policies_unique_password_used_by_list_serialize(
+ self,
+ policy_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if policy_uuid is not None:
+ _path_params['policy_uuid'] = policy_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/policies/unique_password/{policy_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/propertymappings_api.py b/authentik_client/api/propertymappings_api.py
new file mode 100644
index 000000000..6b44d7c7e
--- /dev/null
+++ b/authentik_client/api/propertymappings_api.py
@@ -0,0 +1,32520 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.google_workspace_provider_mapping import GoogleWorkspaceProviderMapping
+from authentik_client.models.google_workspace_provider_mapping_request import GoogleWorkspaceProviderMappingRequest
+from authentik_client.models.kerberos_source_property_mapping import KerberosSourcePropertyMapping
+from authentik_client.models.kerberos_source_property_mapping_request import KerberosSourcePropertyMappingRequest
+from authentik_client.models.ldap_source_property_mapping import LDAPSourcePropertyMapping
+from authentik_client.models.ldap_source_property_mapping_request import LDAPSourcePropertyMappingRequest
+from authentik_client.models.microsoft_entra_provider_mapping import MicrosoftEntraProviderMapping
+from authentik_client.models.microsoft_entra_provider_mapping_request import MicrosoftEntraProviderMappingRequest
+from authentik_client.models.notification_webhook_mapping import NotificationWebhookMapping
+from authentik_client.models.notification_webhook_mapping_request import NotificationWebhookMappingRequest
+from authentik_client.models.o_auth_source_property_mapping import OAuthSourcePropertyMapping
+from authentik_client.models.o_auth_source_property_mapping_request import OAuthSourcePropertyMappingRequest
+from authentik_client.models.paginated_google_workspace_provider_mapping_list import PaginatedGoogleWorkspaceProviderMappingList
+from authentik_client.models.paginated_kerberos_source_property_mapping_list import PaginatedKerberosSourcePropertyMappingList
+from authentik_client.models.paginated_ldap_source_property_mapping_list import PaginatedLDAPSourcePropertyMappingList
+from authentik_client.models.paginated_microsoft_entra_provider_mapping_list import PaginatedMicrosoftEntraProviderMappingList
+from authentik_client.models.paginated_notification_webhook_mapping_list import PaginatedNotificationWebhookMappingList
+from authentik_client.models.paginated_o_auth_source_property_mapping_list import PaginatedOAuthSourcePropertyMappingList
+from authentik_client.models.paginated_plex_source_property_mapping_list import PaginatedPlexSourcePropertyMappingList
+from authentik_client.models.paginated_property_mapping_list import PaginatedPropertyMappingList
+from authentik_client.models.paginated_rac_property_mapping_list import PaginatedRACPropertyMappingList
+from authentik_client.models.paginated_radius_provider_property_mapping_list import PaginatedRadiusProviderPropertyMappingList
+from authentik_client.models.paginated_saml_property_mapping_list import PaginatedSAMLPropertyMappingList
+from authentik_client.models.paginated_saml_source_property_mapping_list import PaginatedSAMLSourcePropertyMappingList
+from authentik_client.models.paginated_scim_mapping_list import PaginatedSCIMMappingList
+from authentik_client.models.paginated_scim_source_property_mapping_list import PaginatedSCIMSourcePropertyMappingList
+from authentik_client.models.paginated_scope_mapping_list import PaginatedScopeMappingList
+from authentik_client.models.paginated_telegram_source_property_mapping_list import PaginatedTelegramSourcePropertyMappingList
+from authentik_client.models.patched_google_workspace_provider_mapping_request import PatchedGoogleWorkspaceProviderMappingRequest
+from authentik_client.models.patched_kerberos_source_property_mapping_request import PatchedKerberosSourcePropertyMappingRequest
+from authentik_client.models.patched_ldap_source_property_mapping_request import PatchedLDAPSourcePropertyMappingRequest
+from authentik_client.models.patched_microsoft_entra_provider_mapping_request import PatchedMicrosoftEntraProviderMappingRequest
+from authentik_client.models.patched_notification_webhook_mapping_request import PatchedNotificationWebhookMappingRequest
+from authentik_client.models.patched_o_auth_source_property_mapping_request import PatchedOAuthSourcePropertyMappingRequest
+from authentik_client.models.patched_plex_source_property_mapping_request import PatchedPlexSourcePropertyMappingRequest
+from authentik_client.models.patched_rac_property_mapping_request import PatchedRACPropertyMappingRequest
+from authentik_client.models.patched_radius_provider_property_mapping_request import PatchedRadiusProviderPropertyMappingRequest
+from authentik_client.models.patched_saml_property_mapping_request import PatchedSAMLPropertyMappingRequest
+from authentik_client.models.patched_saml_source_property_mapping_request import PatchedSAMLSourcePropertyMappingRequest
+from authentik_client.models.patched_scim_mapping_request import PatchedSCIMMappingRequest
+from authentik_client.models.patched_scim_source_property_mapping_request import PatchedSCIMSourcePropertyMappingRequest
+from authentik_client.models.patched_scope_mapping_request import PatchedScopeMappingRequest
+from authentik_client.models.patched_telegram_source_property_mapping_request import PatchedTelegramSourcePropertyMappingRequest
+from authentik_client.models.plex_source_property_mapping import PlexSourcePropertyMapping
+from authentik_client.models.plex_source_property_mapping_request import PlexSourcePropertyMappingRequest
+from authentik_client.models.property_mapping import PropertyMapping
+from authentik_client.models.property_mapping_test_request import PropertyMappingTestRequest
+from authentik_client.models.property_mapping_test_result import PropertyMappingTestResult
+from authentik_client.models.rac_property_mapping import RACPropertyMapping
+from authentik_client.models.rac_property_mapping_request import RACPropertyMappingRequest
+from authentik_client.models.radius_provider_property_mapping import RadiusProviderPropertyMapping
+from authentik_client.models.radius_provider_property_mapping_request import RadiusProviderPropertyMappingRequest
+from authentik_client.models.saml_property_mapping import SAMLPropertyMapping
+from authentik_client.models.saml_property_mapping_request import SAMLPropertyMappingRequest
+from authentik_client.models.saml_source_property_mapping import SAMLSourcePropertyMapping
+from authentik_client.models.saml_source_property_mapping_request import SAMLSourcePropertyMappingRequest
+from authentik_client.models.scim_mapping import SCIMMapping
+from authentik_client.models.scim_mapping_request import SCIMMappingRequest
+from authentik_client.models.scim_source_property_mapping import SCIMSourcePropertyMapping
+from authentik_client.models.scim_source_property_mapping_request import SCIMSourcePropertyMappingRequest
+from authentik_client.models.scope_mapping import ScopeMapping
+from authentik_client.models.scope_mapping_request import ScopeMappingRequest
+from authentik_client.models.telegram_source_property_mapping import TelegramSourcePropertyMapping
+from authentik_client.models.telegram_source_property_mapping_request import TelegramSourcePropertyMappingRequest
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class PropertymappingsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def propertymappings_all_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_all_destroy
+
+ PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_all_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_all_destroy
+
+ PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_all_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_all_destroy
+
+ PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_all_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/all/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_all_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPropertyMappingList:
+ """propertymappings_all_list
+
+ PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_all_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPropertyMappingList]:
+ """propertymappings_all_list
+
+ PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_all_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_all_list
+
+ PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_all_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_all_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PropertyMapping:
+ """propertymappings_all_retrieve
+
+ PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_all_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PropertyMapping]:
+ """propertymappings_all_retrieve
+
+ PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_all_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_all_retrieve
+
+ PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_all_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/all/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_all_test_create(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ format_result: Optional[StrictBool] = None,
+ property_mapping_test_request: Optional[PropertyMappingTestRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PropertyMappingTestResult:
+ """propertymappings_all_test_create
+
+ Test Property Mapping
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param format_result:
+ :type format_result: bool
+ :param property_mapping_test_request:
+ :type property_mapping_test_request: PropertyMappingTestRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_test_create_serialize(
+ pm_uuid=pm_uuid,
+ format_result=format_result,
+ property_mapping_test_request=property_mapping_test_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingTestResult",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_all_test_create_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ format_result: Optional[StrictBool] = None,
+ property_mapping_test_request: Optional[PropertyMappingTestRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PropertyMappingTestResult]:
+ """propertymappings_all_test_create
+
+ Test Property Mapping
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param format_result:
+ :type format_result: bool
+ :param property_mapping_test_request:
+ :type property_mapping_test_request: PropertyMappingTestRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_test_create_serialize(
+ pm_uuid=pm_uuid,
+ format_result=format_result,
+ property_mapping_test_request=property_mapping_test_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingTestResult",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_all_test_create_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ format_result: Optional[StrictBool] = None,
+ property_mapping_test_request: Optional[PropertyMappingTestRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_all_test_create
+
+ Test Property Mapping
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param format_result:
+ :type format_result: bool
+ :param property_mapping_test_request:
+ :type property_mapping_test_request: PropertyMappingTestRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_test_create_serialize(
+ pm_uuid=pm_uuid,
+ format_result=format_result,
+ property_mapping_test_request=property_mapping_test_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingTestResult",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_all_test_create_serialize(
+ self,
+ pm_uuid,
+ format_result,
+ property_mapping_test_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ if format_result is not None:
+
+ _query_params.append(('format_result', format_result))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if property_mapping_test_request is not None:
+ _body_params = property_mapping_test_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/all/{pm_uuid}/test/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_all_types_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """propertymappings_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_all_types_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """propertymappings_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_all_types_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_all_types_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/all/types/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_all_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_all_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_all_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_all_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_all_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/all/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_create(
+ self,
+ notification_webhook_mapping_request: NotificationWebhookMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationWebhookMapping:
+ """propertymappings_notification_create
+
+ NotificationWebhookMapping Viewset
+
+ :param notification_webhook_mapping_request: (required)
+ :type notification_webhook_mapping_request: NotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_create_serialize(
+ notification_webhook_mapping_request=notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_create_with_http_info(
+ self,
+ notification_webhook_mapping_request: NotificationWebhookMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationWebhookMapping]:
+ """propertymappings_notification_create
+
+ NotificationWebhookMapping Viewset
+
+ :param notification_webhook_mapping_request: (required)
+ :type notification_webhook_mapping_request: NotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_create_serialize(
+ notification_webhook_mapping_request=notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_create_without_preload_content(
+ self,
+ notification_webhook_mapping_request: NotificationWebhookMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_create
+
+ NotificationWebhookMapping Viewset
+
+ :param notification_webhook_mapping_request: (required)
+ :type notification_webhook_mapping_request: NotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_create_serialize(
+ notification_webhook_mapping_request=notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_create_serialize(
+ self,
+ notification_webhook_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_webhook_mapping_request is not None:
+ _body_params = notification_webhook_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/notification/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_notification_destroy
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_notification_destroy
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_destroy
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/notification/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedNotificationWebhookMappingList:
+ """propertymappings_notification_list
+
+ NotificationWebhookMapping Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationWebhookMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedNotificationWebhookMappingList]:
+ """propertymappings_notification_list
+
+ NotificationWebhookMapping Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationWebhookMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_list
+
+ NotificationWebhookMapping Viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedNotificationWebhookMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/notification/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ patched_notification_webhook_mapping_request: Optional[PatchedNotificationWebhookMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationWebhookMapping:
+ """propertymappings_notification_partial_update
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_notification_webhook_mapping_request:
+ :type patched_notification_webhook_mapping_request: PatchedNotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_notification_webhook_mapping_request=patched_notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ patched_notification_webhook_mapping_request: Optional[PatchedNotificationWebhookMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationWebhookMapping]:
+ """propertymappings_notification_partial_update
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_notification_webhook_mapping_request:
+ :type patched_notification_webhook_mapping_request: PatchedNotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_notification_webhook_mapping_request=patched_notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ patched_notification_webhook_mapping_request: Optional[PatchedNotificationWebhookMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_partial_update
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_notification_webhook_mapping_request:
+ :type patched_notification_webhook_mapping_request: PatchedNotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_notification_webhook_mapping_request=patched_notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_notification_webhook_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_notification_webhook_mapping_request is not None:
+ _body_params = patched_notification_webhook_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/notification/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationWebhookMapping:
+ """propertymappings_notification_retrieve
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationWebhookMapping]:
+ """propertymappings_notification_retrieve
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_retrieve
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/notification/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ notification_webhook_mapping_request: NotificationWebhookMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> NotificationWebhookMapping:
+ """propertymappings_notification_update
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param notification_webhook_mapping_request: (required)
+ :type notification_webhook_mapping_request: NotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_update_serialize(
+ pm_uuid=pm_uuid,
+ notification_webhook_mapping_request=notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ notification_webhook_mapping_request: NotificationWebhookMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[NotificationWebhookMapping]:
+ """propertymappings_notification_update
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param notification_webhook_mapping_request: (required)
+ :type notification_webhook_mapping_request: NotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_update_serialize(
+ pm_uuid=pm_uuid,
+ notification_webhook_mapping_request=notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ notification_webhook_mapping_request: NotificationWebhookMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_update
+
+ NotificationWebhookMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param notification_webhook_mapping_request: (required)
+ :type notification_webhook_mapping_request: NotificationWebhookMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_update_serialize(
+ pm_uuid=pm_uuid,
+ notification_webhook_mapping_request=notification_webhook_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "NotificationWebhookMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_update_serialize(
+ self,
+ pm_uuid,
+ notification_webhook_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if notification_webhook_mapping_request is not None:
+ _body_params = notification_webhook_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/notification/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_notification_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_notification_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_notification_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_notification_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_notification_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Webhook Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_notification_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Webhook Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_notification_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_notification_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/notification/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_create(
+ self,
+ google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderMapping:
+ """propertymappings_provider_google_workspace_create
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param google_workspace_provider_mapping_request: (required)
+ :type google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_create_serialize(
+ google_workspace_provider_mapping_request=google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_create_with_http_info(
+ self,
+ google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderMapping]:
+ """propertymappings_provider_google_workspace_create
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param google_workspace_provider_mapping_request: (required)
+ :type google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_create_serialize(
+ google_workspace_provider_mapping_request=google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_create_without_preload_content(
+ self,
+ google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_create
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param google_workspace_provider_mapping_request: (required)
+ :type google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_create_serialize(
+ google_workspace_provider_mapping_request=google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_create_serialize(
+ self,
+ google_workspace_provider_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_workspace_provider_mapping_request is not None:
+ _body_params = google_workspace_provider_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/google_workspace/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_google_workspace_destroy
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_google_workspace_destroy
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_destroy
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/google_workspace/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_list(
+ self,
+ expression: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleWorkspaceProviderMappingList:
+ """propertymappings_provider_google_workspace_list
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param expression:
+ :type expression: str
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pm_uuid:
+ :type pm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_list_serialize(
+ expression=expression,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pm_uuid=pm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_list_with_http_info(
+ self,
+ expression: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleWorkspaceProviderMappingList]:
+ """propertymappings_provider_google_workspace_list
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param expression:
+ :type expression: str
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pm_uuid:
+ :type pm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_list_serialize(
+ expression=expression,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pm_uuid=pm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_list_without_preload_content(
+ self,
+ expression: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_list
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param expression:
+ :type expression: str
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pm_uuid:
+ :type pm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_list_serialize(
+ expression=expression,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pm_uuid=pm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_list_serialize(
+ self,
+ expression,
+ managed,
+ name,
+ ordering,
+ page,
+ page_size,
+ pm_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if expression is not None:
+
+ _query_params.append(('expression', expression))
+
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if pm_uuid is not None:
+
+ _query_params.append(('pm_uuid', pm_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/google_workspace/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ patched_google_workspace_provider_mapping_request: Optional[PatchedGoogleWorkspaceProviderMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderMapping:
+ """propertymappings_provider_google_workspace_partial_update
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_google_workspace_provider_mapping_request:
+ :type patched_google_workspace_provider_mapping_request: PatchedGoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_google_workspace_provider_mapping_request=patched_google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ patched_google_workspace_provider_mapping_request: Optional[PatchedGoogleWorkspaceProviderMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderMapping]:
+ """propertymappings_provider_google_workspace_partial_update
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_google_workspace_provider_mapping_request:
+ :type patched_google_workspace_provider_mapping_request: PatchedGoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_google_workspace_provider_mapping_request=patched_google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ patched_google_workspace_provider_mapping_request: Optional[PatchedGoogleWorkspaceProviderMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_partial_update
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_google_workspace_provider_mapping_request:
+ :type patched_google_workspace_provider_mapping_request: PatchedGoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_google_workspace_provider_mapping_request=patched_google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_google_workspace_provider_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_google_workspace_provider_mapping_request is not None:
+ _body_params = patched_google_workspace_provider_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/google_workspace/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderMapping:
+ """propertymappings_provider_google_workspace_retrieve
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderMapping]:
+ """propertymappings_provider_google_workspace_retrieve
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_retrieve
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/google_workspace/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderMapping:
+ """propertymappings_provider_google_workspace_update
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param google_workspace_provider_mapping_request: (required)
+ :type google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_update_serialize(
+ pm_uuid=pm_uuid,
+ google_workspace_provider_mapping_request=google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderMapping]:
+ """propertymappings_provider_google_workspace_update
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param google_workspace_provider_mapping_request: (required)
+ :type google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_update_serialize(
+ pm_uuid=pm_uuid,
+ google_workspace_provider_mapping_request=google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_update
+
+ GoogleWorkspaceProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param google_workspace_provider_mapping_request: (required)
+ :type google_workspace_provider_mapping_request: GoogleWorkspaceProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_update_serialize(
+ pm_uuid=pm_uuid,
+ google_workspace_provider_mapping_request=google_workspace_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_update_serialize(
+ self,
+ pm_uuid,
+ google_workspace_provider_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_workspace_provider_mapping_request is not None:
+ _body_params = google_workspace_provider_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/google_workspace/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_google_workspace_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_google_workspace_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_google_workspace_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_google_workspace_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Google Workspace Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_google_workspace_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_google_workspace_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/google_workspace/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_create(
+ self,
+ microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderMapping:
+ """propertymappings_provider_microsoft_entra_create
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param microsoft_entra_provider_mapping_request: (required)
+ :type microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_create_serialize(
+ microsoft_entra_provider_mapping_request=microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_create_with_http_info(
+ self,
+ microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderMapping]:
+ """propertymappings_provider_microsoft_entra_create
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param microsoft_entra_provider_mapping_request: (required)
+ :type microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_create_serialize(
+ microsoft_entra_provider_mapping_request=microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_create_without_preload_content(
+ self,
+ microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_create
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param microsoft_entra_provider_mapping_request: (required)
+ :type microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_create_serialize(
+ microsoft_entra_provider_mapping_request=microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_create_serialize(
+ self,
+ microsoft_entra_provider_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if microsoft_entra_provider_mapping_request is not None:
+ _body_params = microsoft_entra_provider_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/microsoft_entra/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_microsoft_entra_destroy
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_microsoft_entra_destroy
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_destroy
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/microsoft_entra/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_list(
+ self,
+ expression: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedMicrosoftEntraProviderMappingList:
+ """propertymappings_provider_microsoft_entra_list
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param expression:
+ :type expression: str
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pm_uuid:
+ :type pm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_list_serialize(
+ expression=expression,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pm_uuid=pm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_list_with_http_info(
+ self,
+ expression: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedMicrosoftEntraProviderMappingList]:
+ """propertymappings_provider_microsoft_entra_list
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param expression:
+ :type expression: str
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pm_uuid:
+ :type pm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_list_serialize(
+ expression=expression,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pm_uuid=pm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_list_without_preload_content(
+ self,
+ expression: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_list
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param expression:
+ :type expression: str
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pm_uuid:
+ :type pm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_list_serialize(
+ expression=expression,
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pm_uuid=pm_uuid,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_list_serialize(
+ self,
+ expression,
+ managed,
+ name,
+ ordering,
+ page,
+ page_size,
+ pm_uuid,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if expression is not None:
+
+ _query_params.append(('expression', expression))
+
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if pm_uuid is not None:
+
+ _query_params.append(('pm_uuid', pm_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/microsoft_entra/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ patched_microsoft_entra_provider_mapping_request: Optional[PatchedMicrosoftEntraProviderMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderMapping:
+ """propertymappings_provider_microsoft_entra_partial_update
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_microsoft_entra_provider_mapping_request:
+ :type patched_microsoft_entra_provider_mapping_request: PatchedMicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_microsoft_entra_provider_mapping_request=patched_microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ patched_microsoft_entra_provider_mapping_request: Optional[PatchedMicrosoftEntraProviderMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderMapping]:
+ """propertymappings_provider_microsoft_entra_partial_update
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_microsoft_entra_provider_mapping_request:
+ :type patched_microsoft_entra_provider_mapping_request: PatchedMicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_microsoft_entra_provider_mapping_request=patched_microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ patched_microsoft_entra_provider_mapping_request: Optional[PatchedMicrosoftEntraProviderMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_partial_update
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_microsoft_entra_provider_mapping_request:
+ :type patched_microsoft_entra_provider_mapping_request: PatchedMicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_microsoft_entra_provider_mapping_request=patched_microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_microsoft_entra_provider_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_microsoft_entra_provider_mapping_request is not None:
+ _body_params = patched_microsoft_entra_provider_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/microsoft_entra/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderMapping:
+ """propertymappings_provider_microsoft_entra_retrieve
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderMapping]:
+ """propertymappings_provider_microsoft_entra_retrieve
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_retrieve
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/microsoft_entra/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderMapping:
+ """propertymappings_provider_microsoft_entra_update
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param microsoft_entra_provider_mapping_request: (required)
+ :type microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_update_serialize(
+ pm_uuid=pm_uuid,
+ microsoft_entra_provider_mapping_request=microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderMapping]:
+ """propertymappings_provider_microsoft_entra_update
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param microsoft_entra_provider_mapping_request: (required)
+ :type microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_update_serialize(
+ pm_uuid=pm_uuid,
+ microsoft_entra_provider_mapping_request=microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_update
+
+ MicrosoftEntraProviderMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param microsoft_entra_provider_mapping_request: (required)
+ :type microsoft_entra_provider_mapping_request: MicrosoftEntraProviderMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_update_serialize(
+ pm_uuid=pm_uuid,
+ microsoft_entra_provider_mapping_request=microsoft_entra_provider_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_update_serialize(
+ self,
+ pm_uuid,
+ microsoft_entra_provider_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if microsoft_entra_provider_mapping_request is not None:
+ _body_params = microsoft_entra_provider_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/microsoft_entra/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_microsoft_entra_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_microsoft_entra_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_microsoft_entra_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_microsoft_entra_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Microsoft Entra Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_microsoft_entra_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_microsoft_entra_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/microsoft_entra/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_create(
+ self,
+ rac_property_mapping_request: RACPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACPropertyMapping:
+ """propertymappings_provider_rac_create
+
+ RACPropertyMapping Viewset
+
+ :param rac_property_mapping_request: (required)
+ :type rac_property_mapping_request: RACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_create_serialize(
+ rac_property_mapping_request=rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_create_with_http_info(
+ self,
+ rac_property_mapping_request: RACPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACPropertyMapping]:
+ """propertymappings_provider_rac_create
+
+ RACPropertyMapping Viewset
+
+ :param rac_property_mapping_request: (required)
+ :type rac_property_mapping_request: RACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_create_serialize(
+ rac_property_mapping_request=rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_create_without_preload_content(
+ self,
+ rac_property_mapping_request: RACPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_create
+
+ RACPropertyMapping Viewset
+
+ :param rac_property_mapping_request: (required)
+ :type rac_property_mapping_request: RACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_create_serialize(
+ rac_property_mapping_request=rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_create_serialize(
+ self,
+ rac_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if rac_property_mapping_request is not None:
+ _body_params = rac_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/rac/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_rac_destroy
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_rac_destroy
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_destroy
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/rac/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRACPropertyMappingList:
+ """propertymappings_provider_rac_list
+
+ RACPropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_list_serialize(
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRACPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRACPropertyMappingList]:
+ """propertymappings_provider_rac_list
+
+ RACPropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_list_serialize(
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRACPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_list
+
+ RACPropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_list_serialize(
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRACPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_list_serialize(
+ self,
+ managed,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/rac/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ patched_rac_property_mapping_request: Optional[PatchedRACPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACPropertyMapping:
+ """propertymappings_provider_rac_partial_update
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_rac_property_mapping_request:
+ :type patched_rac_property_mapping_request: PatchedRACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_rac_property_mapping_request=patched_rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ patched_rac_property_mapping_request: Optional[PatchedRACPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACPropertyMapping]:
+ """propertymappings_provider_rac_partial_update
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_rac_property_mapping_request:
+ :type patched_rac_property_mapping_request: PatchedRACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_rac_property_mapping_request=patched_rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ patched_rac_property_mapping_request: Optional[PatchedRACPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_partial_update
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_rac_property_mapping_request:
+ :type patched_rac_property_mapping_request: PatchedRACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_rac_property_mapping_request=patched_rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_rac_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_rac_property_mapping_request is not None:
+ _body_params = patched_rac_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/rac/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACPropertyMapping:
+ """propertymappings_provider_rac_retrieve
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACPropertyMapping]:
+ """propertymappings_provider_rac_retrieve
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_retrieve
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/rac/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ rac_property_mapping_request: RACPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACPropertyMapping:
+ """propertymappings_provider_rac_update
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param rac_property_mapping_request: (required)
+ :type rac_property_mapping_request: RACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_update_serialize(
+ pm_uuid=pm_uuid,
+ rac_property_mapping_request=rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ rac_property_mapping_request: RACPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACPropertyMapping]:
+ """propertymappings_provider_rac_update
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param rac_property_mapping_request: (required)
+ :type rac_property_mapping_request: RACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_update_serialize(
+ pm_uuid=pm_uuid,
+ rac_property_mapping_request=rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ rac_property_mapping_request: RACPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_update
+
+ RACPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param rac_property_mapping_request: (required)
+ :type rac_property_mapping_request: RACPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_update_serialize(
+ pm_uuid=pm_uuid,
+ rac_property_mapping_request=rac_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_update_serialize(
+ self,
+ pm_uuid,
+ rac_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if rac_property_mapping_request is not None:
+ _body_params = rac_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/rac/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_rac_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_rac_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_rac_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_rac_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_rac_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_rac_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this RAC Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_rac_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_rac_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/rac/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_create(
+ self,
+ radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProviderPropertyMapping:
+ """propertymappings_provider_radius_create
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param radius_provider_property_mapping_request: (required)
+ :type radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_create_serialize(
+ radius_provider_property_mapping_request=radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_create_with_http_info(
+ self,
+ radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProviderPropertyMapping]:
+ """propertymappings_provider_radius_create
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param radius_provider_property_mapping_request: (required)
+ :type radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_create_serialize(
+ radius_provider_property_mapping_request=radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_create_without_preload_content(
+ self,
+ radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_create
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param radius_provider_property_mapping_request: (required)
+ :type radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_create_serialize(
+ radius_provider_property_mapping_request=radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_create_serialize(
+ self,
+ radius_provider_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if radius_provider_property_mapping_request is not None:
+ _body_params = radius_provider_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/radius/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_radius_destroy
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_radius_destroy
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_destroy
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/radius/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRadiusProviderPropertyMappingList:
+ """propertymappings_provider_radius_list
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusProviderPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRadiusProviderPropertyMappingList]:
+ """propertymappings_provider_radius_list
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusProviderPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_list
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusProviderPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/radius/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ patched_radius_provider_property_mapping_request: Optional[PatchedRadiusProviderPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProviderPropertyMapping:
+ """propertymappings_provider_radius_partial_update
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_radius_provider_property_mapping_request:
+ :type patched_radius_provider_property_mapping_request: PatchedRadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_radius_provider_property_mapping_request=patched_radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ patched_radius_provider_property_mapping_request: Optional[PatchedRadiusProviderPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProviderPropertyMapping]:
+ """propertymappings_provider_radius_partial_update
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_radius_provider_property_mapping_request:
+ :type patched_radius_provider_property_mapping_request: PatchedRadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_radius_provider_property_mapping_request=patched_radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ patched_radius_provider_property_mapping_request: Optional[PatchedRadiusProviderPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_partial_update
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_radius_provider_property_mapping_request:
+ :type patched_radius_provider_property_mapping_request: PatchedRadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_radius_provider_property_mapping_request=patched_radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_radius_provider_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_radius_provider_property_mapping_request is not None:
+ _body_params = patched_radius_provider_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/radius/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProviderPropertyMapping:
+ """propertymappings_provider_radius_retrieve
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProviderPropertyMapping]:
+ """propertymappings_provider_radius_retrieve
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_retrieve
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/radius/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProviderPropertyMapping:
+ """propertymappings_provider_radius_update
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param radius_provider_property_mapping_request: (required)
+ :type radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_update_serialize(
+ pm_uuid=pm_uuid,
+ radius_provider_property_mapping_request=radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProviderPropertyMapping]:
+ """propertymappings_provider_radius_update
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param radius_provider_property_mapping_request: (required)
+ :type radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_update_serialize(
+ pm_uuid=pm_uuid,
+ radius_provider_property_mapping_request=radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_update
+
+ RadiusProviderPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param radius_provider_property_mapping_request: (required)
+ :type radius_provider_property_mapping_request: RadiusProviderPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_update_serialize(
+ pm_uuid=pm_uuid,
+ radius_provider_property_mapping_request=radius_provider_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProviderPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_update_serialize(
+ self,
+ pm_uuid,
+ radius_provider_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if radius_provider_property_mapping_request is not None:
+ _body_params = radius_provider_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/radius/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_radius_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_radius_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_radius_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_radius_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_radius_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Radius Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_radius_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Radius Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_radius_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_radius_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/radius/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_create(
+ self,
+ saml_property_mapping_request: SAMLPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLPropertyMapping:
+ """propertymappings_provider_saml_create
+
+ SAMLPropertyMapping Viewset
+
+ :param saml_property_mapping_request: (required)
+ :type saml_property_mapping_request: SAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_create_serialize(
+ saml_property_mapping_request=saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_create_with_http_info(
+ self,
+ saml_property_mapping_request: SAMLPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLPropertyMapping]:
+ """propertymappings_provider_saml_create
+
+ SAMLPropertyMapping Viewset
+
+ :param saml_property_mapping_request: (required)
+ :type saml_property_mapping_request: SAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_create_serialize(
+ saml_property_mapping_request=saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_create_without_preload_content(
+ self,
+ saml_property_mapping_request: SAMLPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_create
+
+ SAMLPropertyMapping Viewset
+
+ :param saml_property_mapping_request: (required)
+ :type saml_property_mapping_request: SAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_create_serialize(
+ saml_property_mapping_request=saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_create_serialize(
+ self,
+ saml_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if saml_property_mapping_request is not None:
+ _body_params = saml_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/saml/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_saml_destroy
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_saml_destroy
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_destroy
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_list(
+ self,
+ friendly_name: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ saml_name: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSAMLPropertyMappingList:
+ """propertymappings_provider_saml_list
+
+ SAMLPropertyMapping Viewset
+
+ :param friendly_name:
+ :type friendly_name: str
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param saml_name:
+ :type saml_name: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_list_serialize(
+ friendly_name=friendly_name,
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ saml_name=saml_name,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_list_with_http_info(
+ self,
+ friendly_name: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ saml_name: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSAMLPropertyMappingList]:
+ """propertymappings_provider_saml_list
+
+ SAMLPropertyMapping Viewset
+
+ :param friendly_name:
+ :type friendly_name: str
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param saml_name:
+ :type saml_name: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_list_serialize(
+ friendly_name=friendly_name,
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ saml_name=saml_name,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_list_without_preload_content(
+ self,
+ friendly_name: Optional[StrictStr] = None,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ saml_name: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_list
+
+ SAMLPropertyMapping Viewset
+
+ :param friendly_name:
+ :type friendly_name: str
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param saml_name:
+ :type saml_name: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_list_serialize(
+ friendly_name=friendly_name,
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ saml_name=saml_name,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLPropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_list_serialize(
+ self,
+ friendly_name,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ saml_name,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if friendly_name is not None:
+
+ _query_params.append(('friendly_name', friendly_name))
+
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if saml_name is not None:
+
+ _query_params.append(('saml_name', saml_name))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/saml/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ patched_saml_property_mapping_request: Optional[PatchedSAMLPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLPropertyMapping:
+ """propertymappings_provider_saml_partial_update
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_saml_property_mapping_request:
+ :type patched_saml_property_mapping_request: PatchedSAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_saml_property_mapping_request=patched_saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ patched_saml_property_mapping_request: Optional[PatchedSAMLPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLPropertyMapping]:
+ """propertymappings_provider_saml_partial_update
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_saml_property_mapping_request:
+ :type patched_saml_property_mapping_request: PatchedSAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_saml_property_mapping_request=patched_saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ patched_saml_property_mapping_request: Optional[PatchedSAMLPropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_partial_update
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_saml_property_mapping_request:
+ :type patched_saml_property_mapping_request: PatchedSAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_saml_property_mapping_request=patched_saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_saml_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_saml_property_mapping_request is not None:
+ _body_params = patched_saml_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLPropertyMapping:
+ """propertymappings_provider_saml_retrieve
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLPropertyMapping]:
+ """propertymappings_provider_saml_retrieve
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_retrieve
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ saml_property_mapping_request: SAMLPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLPropertyMapping:
+ """propertymappings_provider_saml_update
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param saml_property_mapping_request: (required)
+ :type saml_property_mapping_request: SAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_update_serialize(
+ pm_uuid=pm_uuid,
+ saml_property_mapping_request=saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ saml_property_mapping_request: SAMLPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLPropertyMapping]:
+ """propertymappings_provider_saml_update
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param saml_property_mapping_request: (required)
+ :type saml_property_mapping_request: SAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_update_serialize(
+ pm_uuid=pm_uuid,
+ saml_property_mapping_request=saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ saml_property_mapping_request: SAMLPropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_update
+
+ SAMLPropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param saml_property_mapping_request: (required)
+ :type saml_property_mapping_request: SAMLPropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_update_serialize(
+ pm_uuid=pm_uuid,
+ saml_property_mapping_request=saml_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLPropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_update_serialize(
+ self,
+ pm_uuid,
+ saml_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if saml_property_mapping_request is not None:
+ _body_params = saml_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_saml_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_saml_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_saml_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Provider Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SAML Provider Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_saml_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_saml_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/saml/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_create(
+ self,
+ scim_mapping_request: SCIMMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMMapping:
+ """propertymappings_provider_scim_create
+
+ SCIMMapping Viewset
+
+ :param scim_mapping_request: (required)
+ :type scim_mapping_request: SCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_create_serialize(
+ scim_mapping_request=scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_create_with_http_info(
+ self,
+ scim_mapping_request: SCIMMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMMapping]:
+ """propertymappings_provider_scim_create
+
+ SCIMMapping Viewset
+
+ :param scim_mapping_request: (required)
+ :type scim_mapping_request: SCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_create_serialize(
+ scim_mapping_request=scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_create_without_preload_content(
+ self,
+ scim_mapping_request: SCIMMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_create
+
+ SCIMMapping Viewset
+
+ :param scim_mapping_request: (required)
+ :type scim_mapping_request: SCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_create_serialize(
+ scim_mapping_request=scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_create_serialize(
+ self,
+ scim_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_mapping_request is not None:
+ _body_params = scim_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/scim/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_scim_destroy
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_scim_destroy
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_destroy
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSCIMMappingList:
+ """propertymappings_provider_scim_list
+
+ SCIMMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSCIMMappingList]:
+ """propertymappings_provider_scim_list
+
+ SCIMMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_list
+
+ SCIMMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/scim/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ patched_scim_mapping_request: Optional[PatchedSCIMMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMMapping:
+ """propertymappings_provider_scim_partial_update
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scim_mapping_request:
+ :type patched_scim_mapping_request: PatchedSCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scim_mapping_request=patched_scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ patched_scim_mapping_request: Optional[PatchedSCIMMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMMapping]:
+ """propertymappings_provider_scim_partial_update
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scim_mapping_request:
+ :type patched_scim_mapping_request: PatchedSCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scim_mapping_request=patched_scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ patched_scim_mapping_request: Optional[PatchedSCIMMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_partial_update
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scim_mapping_request:
+ :type patched_scim_mapping_request: PatchedSCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scim_mapping_request=patched_scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_scim_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_scim_mapping_request is not None:
+ _body_params = patched_scim_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMMapping:
+ """propertymappings_provider_scim_retrieve
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMMapping]:
+ """propertymappings_provider_scim_retrieve
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_retrieve
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ scim_mapping_request: SCIMMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMMapping:
+ """propertymappings_provider_scim_update
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param scim_mapping_request: (required)
+ :type scim_mapping_request: SCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_update_serialize(
+ pm_uuid=pm_uuid,
+ scim_mapping_request=scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ scim_mapping_request: SCIMMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMMapping]:
+ """propertymappings_provider_scim_update
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param scim_mapping_request: (required)
+ :type scim_mapping_request: SCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_update_serialize(
+ pm_uuid=pm_uuid,
+ scim_mapping_request=scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ scim_mapping_request: SCIMMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_update
+
+ SCIMMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param scim_mapping_request: (required)
+ :type scim_mapping_request: SCIMMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_update_serialize(
+ pm_uuid=pm_uuid,
+ scim_mapping_request=scim_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_update_serialize(
+ self,
+ pm_uuid,
+ scim_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_mapping_request is not None:
+ _body_params = scim_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scim_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scim_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scim_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Provider Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SCIM Provider Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scim_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scim_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/scim/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_create(
+ self,
+ scope_mapping_request: ScopeMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ScopeMapping:
+ """propertymappings_provider_scope_create
+
+ ScopeMapping Viewset
+
+ :param scope_mapping_request: (required)
+ :type scope_mapping_request: ScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_create_serialize(
+ scope_mapping_request=scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_create_with_http_info(
+ self,
+ scope_mapping_request: ScopeMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ScopeMapping]:
+ """propertymappings_provider_scope_create
+
+ ScopeMapping Viewset
+
+ :param scope_mapping_request: (required)
+ :type scope_mapping_request: ScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_create_serialize(
+ scope_mapping_request=scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_create_without_preload_content(
+ self,
+ scope_mapping_request: ScopeMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_create
+
+ ScopeMapping Viewset
+
+ :param scope_mapping_request: (required)
+ :type scope_mapping_request: ScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_create_serialize(
+ scope_mapping_request=scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_create_serialize(
+ self,
+ scope_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scope_mapping_request is not None:
+ _body_params = scope_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/provider/scope/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_provider_scope_destroy
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_provider_scope_destroy
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_destroy
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/provider/scope/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ scope_name: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedScopeMappingList:
+ """propertymappings_provider_scope_list
+
+ ScopeMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param scope_name:
+ :type scope_name: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ scope_name=scope_name,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedScopeMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ scope_name: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedScopeMappingList]:
+ """propertymappings_provider_scope_list
+
+ ScopeMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param scope_name:
+ :type scope_name: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ scope_name=scope_name,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedScopeMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ scope_name: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_list
+
+ ScopeMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param scope_name:
+ :type scope_name: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ scope_name=scope_name,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedScopeMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ scope_name,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if scope_name is not None:
+
+ _query_params.append(('scope_name', scope_name))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/scope/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ patched_scope_mapping_request: Optional[PatchedScopeMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ScopeMapping:
+ """propertymappings_provider_scope_partial_update
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scope_mapping_request:
+ :type patched_scope_mapping_request: PatchedScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scope_mapping_request=patched_scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ patched_scope_mapping_request: Optional[PatchedScopeMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ScopeMapping]:
+ """propertymappings_provider_scope_partial_update
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scope_mapping_request:
+ :type patched_scope_mapping_request: PatchedScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scope_mapping_request=patched_scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ patched_scope_mapping_request: Optional[PatchedScopeMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_partial_update
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scope_mapping_request:
+ :type patched_scope_mapping_request: PatchedScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scope_mapping_request=patched_scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_scope_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_scope_mapping_request is not None:
+ _body_params = patched_scope_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/provider/scope/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ScopeMapping:
+ """propertymappings_provider_scope_retrieve
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ScopeMapping]:
+ """propertymappings_provider_scope_retrieve
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_retrieve
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/scope/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ scope_mapping_request: ScopeMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ScopeMapping:
+ """propertymappings_provider_scope_update
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param scope_mapping_request: (required)
+ :type scope_mapping_request: ScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_update_serialize(
+ pm_uuid=pm_uuid,
+ scope_mapping_request=scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ scope_mapping_request: ScopeMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ScopeMapping]:
+ """propertymappings_provider_scope_update
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param scope_mapping_request: (required)
+ :type scope_mapping_request: ScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_update_serialize(
+ pm_uuid=pm_uuid,
+ scope_mapping_request=scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ scope_mapping_request: ScopeMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_update
+
+ ScopeMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param scope_mapping_request: (required)
+ :type scope_mapping_request: ScopeMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_update_serialize(
+ pm_uuid=pm_uuid,
+ scope_mapping_request=scope_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ScopeMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_update_serialize(
+ self,
+ pm_uuid,
+ scope_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scope_mapping_request is not None:
+ _body_params = scope_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/provider/scope/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_provider_scope_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_provider_scope_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_provider_scope_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_provider_scope_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_provider_scope_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Scope Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_provider_scope_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Scope Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_provider_scope_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_provider_scope_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/provider/scope/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_create(
+ self,
+ kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KerberosSourcePropertyMapping:
+ """propertymappings_source_kerberos_create
+
+ KerberosSource PropertyMapping Viewset
+
+ :param kerberos_source_property_mapping_request: (required)
+ :type kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_create_serialize(
+ kerberos_source_property_mapping_request=kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_create_with_http_info(
+ self,
+ kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KerberosSourcePropertyMapping]:
+ """propertymappings_source_kerberos_create
+
+ KerberosSource PropertyMapping Viewset
+
+ :param kerberos_source_property_mapping_request: (required)
+ :type kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_create_serialize(
+ kerberos_source_property_mapping_request=kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_create_without_preload_content(
+ self,
+ kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_create
+
+ KerberosSource PropertyMapping Viewset
+
+ :param kerberos_source_property_mapping_request: (required)
+ :type kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_create_serialize(
+ kerberos_source_property_mapping_request=kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_create_serialize(
+ self,
+ kerberos_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if kerberos_source_property_mapping_request is not None:
+ _body_params = kerberos_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/kerberos/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_kerberos_destroy
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_kerberos_destroy
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_destroy
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/kerberos/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedKerberosSourcePropertyMappingList:
+ """propertymappings_source_kerberos_list
+
+ KerberosSource PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedKerberosSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedKerberosSourcePropertyMappingList]:
+ """propertymappings_source_kerberos_list
+
+ KerberosSource PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedKerberosSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_list
+
+ KerberosSource PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedKerberosSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/kerberos/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ patched_kerberos_source_property_mapping_request: Optional[PatchedKerberosSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KerberosSourcePropertyMapping:
+ """propertymappings_source_kerberos_partial_update
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_kerberos_source_property_mapping_request:
+ :type patched_kerberos_source_property_mapping_request: PatchedKerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_kerberos_source_property_mapping_request=patched_kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ patched_kerberos_source_property_mapping_request: Optional[PatchedKerberosSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KerberosSourcePropertyMapping]:
+ """propertymappings_source_kerberos_partial_update
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_kerberos_source_property_mapping_request:
+ :type patched_kerberos_source_property_mapping_request: PatchedKerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_kerberos_source_property_mapping_request=patched_kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ patched_kerberos_source_property_mapping_request: Optional[PatchedKerberosSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_partial_update
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_kerberos_source_property_mapping_request:
+ :type patched_kerberos_source_property_mapping_request: PatchedKerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_kerberos_source_property_mapping_request=patched_kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_kerberos_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_kerberos_source_property_mapping_request is not None:
+ _body_params = patched_kerberos_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/kerberos/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KerberosSourcePropertyMapping:
+ """propertymappings_source_kerberos_retrieve
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KerberosSourcePropertyMapping]:
+ """propertymappings_source_kerberos_retrieve
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_retrieve
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/kerberos/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> KerberosSourcePropertyMapping:
+ """propertymappings_source_kerberos_update
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param kerberos_source_property_mapping_request: (required)
+ :type kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_update_serialize(
+ pm_uuid=pm_uuid,
+ kerberos_source_property_mapping_request=kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[KerberosSourcePropertyMapping]:
+ """propertymappings_source_kerberos_update
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param kerberos_source_property_mapping_request: (required)
+ :type kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_update_serialize(
+ pm_uuid=pm_uuid,
+ kerberos_source_property_mapping_request=kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_update
+
+ KerberosSource PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param kerberos_source_property_mapping_request: (required)
+ :type kerberos_source_property_mapping_request: KerberosSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_update_serialize(
+ pm_uuid=pm_uuid,
+ kerberos_source_property_mapping_request=kerberos_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "KerberosSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_update_serialize(
+ self,
+ pm_uuid,
+ kerberos_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if kerberos_source_property_mapping_request is not None:
+ _body_params = kerberos_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/kerberos/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_kerberos_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_kerberos_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_kerberos_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_kerberos_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_kerberos_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Kerberos Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_kerberos_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Kerberos Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_kerberos_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_kerberos_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/kerberos/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_create(
+ self,
+ ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPSourcePropertyMapping:
+ """propertymappings_source_ldap_create
+
+ LDAP PropertyMapping Viewset
+
+ :param ldap_source_property_mapping_request: (required)
+ :type ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_create_serialize(
+ ldap_source_property_mapping_request=ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_create_with_http_info(
+ self,
+ ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPSourcePropertyMapping]:
+ """propertymappings_source_ldap_create
+
+ LDAP PropertyMapping Viewset
+
+ :param ldap_source_property_mapping_request: (required)
+ :type ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_create_serialize(
+ ldap_source_property_mapping_request=ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_create_without_preload_content(
+ self,
+ ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_create
+
+ LDAP PropertyMapping Viewset
+
+ :param ldap_source_property_mapping_request: (required)
+ :type ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_create_serialize(
+ ldap_source_property_mapping_request=ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_create_serialize(
+ self,
+ ldap_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ldap_source_property_mapping_request is not None:
+ _body_params = ldap_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_ldap_destroy
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_ldap_destroy
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_destroy
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/ldap/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedLDAPSourcePropertyMappingList:
+ """propertymappings_source_ldap_list
+
+ LDAP PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedLDAPSourcePropertyMappingList]:
+ """propertymappings_source_ldap_list
+
+ LDAP PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_list
+
+ LDAP PropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ patched_ldap_source_property_mapping_request: Optional[PatchedLDAPSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPSourcePropertyMapping:
+ """propertymappings_source_ldap_partial_update
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_ldap_source_property_mapping_request:
+ :type patched_ldap_source_property_mapping_request: PatchedLDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_ldap_source_property_mapping_request=patched_ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ patched_ldap_source_property_mapping_request: Optional[PatchedLDAPSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPSourcePropertyMapping]:
+ """propertymappings_source_ldap_partial_update
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_ldap_source_property_mapping_request:
+ :type patched_ldap_source_property_mapping_request: PatchedLDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_ldap_source_property_mapping_request=patched_ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ patched_ldap_source_property_mapping_request: Optional[PatchedLDAPSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_partial_update
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_ldap_source_property_mapping_request:
+ :type patched_ldap_source_property_mapping_request: PatchedLDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_ldap_source_property_mapping_request=patched_ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_ldap_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_ldap_source_property_mapping_request is not None:
+ _body_params = patched_ldap_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/ldap/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPSourcePropertyMapping:
+ """propertymappings_source_ldap_retrieve
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPSourcePropertyMapping]:
+ """propertymappings_source_ldap_retrieve
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_retrieve
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/ldap/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPSourcePropertyMapping:
+ """propertymappings_source_ldap_update
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param ldap_source_property_mapping_request: (required)
+ :type ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_update_serialize(
+ pm_uuid=pm_uuid,
+ ldap_source_property_mapping_request=ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPSourcePropertyMapping]:
+ """propertymappings_source_ldap_update
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param ldap_source_property_mapping_request: (required)
+ :type ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_update_serialize(
+ pm_uuid=pm_uuid,
+ ldap_source_property_mapping_request=ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_update
+
+ LDAP PropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param ldap_source_property_mapping_request: (required)
+ :type ldap_source_property_mapping_request: LDAPSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_update_serialize(
+ pm_uuid=pm_uuid,
+ ldap_source_property_mapping_request=ldap_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_update_serialize(
+ self,
+ pm_uuid,
+ ldap_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ldap_source_property_mapping_request is not None:
+ _body_params = ldap_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/ldap/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_ldap_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_ldap_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_ldap_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this LDAP Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this LDAP Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_ldap_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_ldap_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/ldap/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_create(
+ self,
+ o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuthSourcePropertyMapping:
+ """propertymappings_source_oauth_create
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param o_auth_source_property_mapping_request: (required)
+ :type o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_create_serialize(
+ o_auth_source_property_mapping_request=o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_create_with_http_info(
+ self,
+ o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuthSourcePropertyMapping]:
+ """propertymappings_source_oauth_create
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param o_auth_source_property_mapping_request: (required)
+ :type o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_create_serialize(
+ o_auth_source_property_mapping_request=o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_create_without_preload_content(
+ self,
+ o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_create
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param o_auth_source_property_mapping_request: (required)
+ :type o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_create_serialize(
+ o_auth_source_property_mapping_request=o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_create_serialize(
+ self,
+ o_auth_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if o_auth_source_property_mapping_request is not None:
+ _body_params = o_auth_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/oauth/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_oauth_destroy
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_oauth_destroy
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_destroy
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/oauth/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedOAuthSourcePropertyMappingList:
+ """propertymappings_source_oauth_list
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOAuthSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedOAuthSourcePropertyMappingList]:
+ """propertymappings_source_oauth_list
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOAuthSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_list
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOAuthSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/oauth/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ patched_o_auth_source_property_mapping_request: Optional[PatchedOAuthSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuthSourcePropertyMapping:
+ """propertymappings_source_oauth_partial_update
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_o_auth_source_property_mapping_request:
+ :type patched_o_auth_source_property_mapping_request: PatchedOAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_o_auth_source_property_mapping_request=patched_o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ patched_o_auth_source_property_mapping_request: Optional[PatchedOAuthSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuthSourcePropertyMapping]:
+ """propertymappings_source_oauth_partial_update
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_o_auth_source_property_mapping_request:
+ :type patched_o_auth_source_property_mapping_request: PatchedOAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_o_auth_source_property_mapping_request=patched_o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ patched_o_auth_source_property_mapping_request: Optional[PatchedOAuthSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_partial_update
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_o_auth_source_property_mapping_request:
+ :type patched_o_auth_source_property_mapping_request: PatchedOAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_o_auth_source_property_mapping_request=patched_o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_o_auth_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_o_auth_source_property_mapping_request is not None:
+ _body_params = patched_o_auth_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/oauth/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuthSourcePropertyMapping:
+ """propertymappings_source_oauth_retrieve
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuthSourcePropertyMapping]:
+ """propertymappings_source_oauth_retrieve
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_retrieve
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/oauth/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuthSourcePropertyMapping:
+ """propertymappings_source_oauth_update
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param o_auth_source_property_mapping_request: (required)
+ :type o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_update_serialize(
+ pm_uuid=pm_uuid,
+ o_auth_source_property_mapping_request=o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuthSourcePropertyMapping]:
+ """propertymappings_source_oauth_update
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param o_auth_source_property_mapping_request: (required)
+ :type o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_update_serialize(
+ pm_uuid=pm_uuid,
+ o_auth_source_property_mapping_request=o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_update
+
+ OAuthSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param o_auth_source_property_mapping_request: (required)
+ :type o_auth_source_property_mapping_request: OAuthSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_update_serialize(
+ pm_uuid=pm_uuid,
+ o_auth_source_property_mapping_request=o_auth_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuthSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_update_serialize(
+ self,
+ pm_uuid,
+ o_auth_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if o_auth_source_property_mapping_request is not None:
+ _body_params = o_auth_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/oauth/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_oauth_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_oauth_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_oauth_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_oauth_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_oauth_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this OAuth Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_oauth_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this OAuth Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_oauth_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_oauth_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/oauth/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_create(
+ self,
+ plex_source_property_mapping_request: PlexSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PlexSourcePropertyMapping:
+ """propertymappings_source_plex_create
+
+ PlexSourcePropertyMapping Viewset
+
+ :param plex_source_property_mapping_request: (required)
+ :type plex_source_property_mapping_request: PlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_create_serialize(
+ plex_source_property_mapping_request=plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_create_with_http_info(
+ self,
+ plex_source_property_mapping_request: PlexSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PlexSourcePropertyMapping]:
+ """propertymappings_source_plex_create
+
+ PlexSourcePropertyMapping Viewset
+
+ :param plex_source_property_mapping_request: (required)
+ :type plex_source_property_mapping_request: PlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_create_serialize(
+ plex_source_property_mapping_request=plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_create_without_preload_content(
+ self,
+ plex_source_property_mapping_request: PlexSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_create
+
+ PlexSourcePropertyMapping Viewset
+
+ :param plex_source_property_mapping_request: (required)
+ :type plex_source_property_mapping_request: PlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_create_serialize(
+ plex_source_property_mapping_request=plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_create_serialize(
+ self,
+ plex_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if plex_source_property_mapping_request is not None:
+ _body_params = plex_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/plex/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_plex_destroy
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_plex_destroy
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_destroy
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/plex/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPlexSourcePropertyMappingList:
+ """propertymappings_source_plex_list
+
+ PlexSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPlexSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPlexSourcePropertyMappingList]:
+ """propertymappings_source_plex_list
+
+ PlexSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPlexSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_list
+
+ PlexSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPlexSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/plex/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ patched_plex_source_property_mapping_request: Optional[PatchedPlexSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PlexSourcePropertyMapping:
+ """propertymappings_source_plex_partial_update
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_plex_source_property_mapping_request:
+ :type patched_plex_source_property_mapping_request: PatchedPlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_plex_source_property_mapping_request=patched_plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ patched_plex_source_property_mapping_request: Optional[PatchedPlexSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PlexSourcePropertyMapping]:
+ """propertymappings_source_plex_partial_update
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_plex_source_property_mapping_request:
+ :type patched_plex_source_property_mapping_request: PatchedPlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_plex_source_property_mapping_request=patched_plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ patched_plex_source_property_mapping_request: Optional[PatchedPlexSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_partial_update
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_plex_source_property_mapping_request:
+ :type patched_plex_source_property_mapping_request: PatchedPlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_plex_source_property_mapping_request=patched_plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_plex_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_plex_source_property_mapping_request is not None:
+ _body_params = patched_plex_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/plex/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PlexSourcePropertyMapping:
+ """propertymappings_source_plex_retrieve
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PlexSourcePropertyMapping]:
+ """propertymappings_source_plex_retrieve
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_retrieve
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/plex/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ plex_source_property_mapping_request: PlexSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PlexSourcePropertyMapping:
+ """propertymappings_source_plex_update
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param plex_source_property_mapping_request: (required)
+ :type plex_source_property_mapping_request: PlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_update_serialize(
+ pm_uuid=pm_uuid,
+ plex_source_property_mapping_request=plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ plex_source_property_mapping_request: PlexSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PlexSourcePropertyMapping]:
+ """propertymappings_source_plex_update
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param plex_source_property_mapping_request: (required)
+ :type plex_source_property_mapping_request: PlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_update_serialize(
+ pm_uuid=pm_uuid,
+ plex_source_property_mapping_request=plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ plex_source_property_mapping_request: PlexSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_update
+
+ PlexSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param plex_source_property_mapping_request: (required)
+ :type plex_source_property_mapping_request: PlexSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_update_serialize(
+ pm_uuid=pm_uuid,
+ plex_source_property_mapping_request=plex_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PlexSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_update_serialize(
+ self,
+ pm_uuid,
+ plex_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if plex_source_property_mapping_request is not None:
+ _body_params = plex_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/plex/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_plex_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_plex_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_plex_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_plex_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_plex_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Plex Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_plex_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Plex Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_plex_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_plex_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/plex/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_create(
+ self,
+ saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLSourcePropertyMapping:
+ """propertymappings_source_saml_create
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param saml_source_property_mapping_request: (required)
+ :type saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_create_serialize(
+ saml_source_property_mapping_request=saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_create_with_http_info(
+ self,
+ saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLSourcePropertyMapping]:
+ """propertymappings_source_saml_create
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param saml_source_property_mapping_request: (required)
+ :type saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_create_serialize(
+ saml_source_property_mapping_request=saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_create_without_preload_content(
+ self,
+ saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_create
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param saml_source_property_mapping_request: (required)
+ :type saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_create_serialize(
+ saml_source_property_mapping_request=saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_create_serialize(
+ self,
+ saml_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if saml_source_property_mapping_request is not None:
+ _body_params = saml_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/saml/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_saml_destroy
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_saml_destroy
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_destroy
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSAMLSourcePropertyMappingList:
+ """propertymappings_source_saml_list
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSAMLSourcePropertyMappingList]:
+ """propertymappings_source_saml_list
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_list
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/saml/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ patched_saml_source_property_mapping_request: Optional[PatchedSAMLSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLSourcePropertyMapping:
+ """propertymappings_source_saml_partial_update
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_saml_source_property_mapping_request:
+ :type patched_saml_source_property_mapping_request: PatchedSAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_saml_source_property_mapping_request=patched_saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ patched_saml_source_property_mapping_request: Optional[PatchedSAMLSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLSourcePropertyMapping]:
+ """propertymappings_source_saml_partial_update
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_saml_source_property_mapping_request:
+ :type patched_saml_source_property_mapping_request: PatchedSAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_saml_source_property_mapping_request=patched_saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ patched_saml_source_property_mapping_request: Optional[PatchedSAMLSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_partial_update
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_saml_source_property_mapping_request:
+ :type patched_saml_source_property_mapping_request: PatchedSAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_saml_source_property_mapping_request=patched_saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_saml_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_saml_source_property_mapping_request is not None:
+ _body_params = patched_saml_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLSourcePropertyMapping:
+ """propertymappings_source_saml_retrieve
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLSourcePropertyMapping]:
+ """propertymappings_source_saml_retrieve
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_retrieve
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLSourcePropertyMapping:
+ """propertymappings_source_saml_update
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param saml_source_property_mapping_request: (required)
+ :type saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_update_serialize(
+ pm_uuid=pm_uuid,
+ saml_source_property_mapping_request=saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLSourcePropertyMapping]:
+ """propertymappings_source_saml_update
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param saml_source_property_mapping_request: (required)
+ :type saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_update_serialize(
+ pm_uuid=pm_uuid,
+ saml_source_property_mapping_request=saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_update
+
+ SAMLSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param saml_source_property_mapping_request: (required)
+ :type saml_source_property_mapping_request: SAMLSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_update_serialize(
+ pm_uuid=pm_uuid,
+ saml_source_property_mapping_request=saml_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_update_serialize(
+ self,
+ pm_uuid,
+ saml_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if saml_source_property_mapping_request is not None:
+ _body_params = saml_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/saml/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_saml_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_saml_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_saml_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SAML Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SAML Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_saml_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_saml_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/saml/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_create(
+ self,
+ scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMSourcePropertyMapping:
+ """propertymappings_source_scim_create
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param scim_source_property_mapping_request: (required)
+ :type scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_create_serialize(
+ scim_source_property_mapping_request=scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_create_with_http_info(
+ self,
+ scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMSourcePropertyMapping]:
+ """propertymappings_source_scim_create
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param scim_source_property_mapping_request: (required)
+ :type scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_create_serialize(
+ scim_source_property_mapping_request=scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_create_without_preload_content(
+ self,
+ scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_create
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param scim_source_property_mapping_request: (required)
+ :type scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_create_serialize(
+ scim_source_property_mapping_request=scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_create_serialize(
+ self,
+ scim_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_source_property_mapping_request is not None:
+ _body_params = scim_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/scim/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_scim_destroy
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_scim_destroy
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_destroy
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSCIMSourcePropertyMappingList:
+ """propertymappings_source_scim_list
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSCIMSourcePropertyMappingList]:
+ """propertymappings_source_scim_list
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_list
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/scim/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ patched_scim_source_property_mapping_request: Optional[PatchedSCIMSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMSourcePropertyMapping:
+ """propertymappings_source_scim_partial_update
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scim_source_property_mapping_request:
+ :type patched_scim_source_property_mapping_request: PatchedSCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scim_source_property_mapping_request=patched_scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ patched_scim_source_property_mapping_request: Optional[PatchedSCIMSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMSourcePropertyMapping]:
+ """propertymappings_source_scim_partial_update
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scim_source_property_mapping_request:
+ :type patched_scim_source_property_mapping_request: PatchedSCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scim_source_property_mapping_request=patched_scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ patched_scim_source_property_mapping_request: Optional[PatchedSCIMSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_partial_update
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_scim_source_property_mapping_request:
+ :type patched_scim_source_property_mapping_request: PatchedSCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_scim_source_property_mapping_request=patched_scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_scim_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_scim_source_property_mapping_request is not None:
+ _body_params = patched_scim_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMSourcePropertyMapping:
+ """propertymappings_source_scim_retrieve
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMSourcePropertyMapping]:
+ """propertymappings_source_scim_retrieve
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_retrieve
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMSourcePropertyMapping:
+ """propertymappings_source_scim_update
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param scim_source_property_mapping_request: (required)
+ :type scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_update_serialize(
+ pm_uuid=pm_uuid,
+ scim_source_property_mapping_request=scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMSourcePropertyMapping]:
+ """propertymappings_source_scim_update
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param scim_source_property_mapping_request: (required)
+ :type scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_update_serialize(
+ pm_uuid=pm_uuid,
+ scim_source_property_mapping_request=scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_update
+
+ SCIMSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param scim_source_property_mapping_request: (required)
+ :type scim_source_property_mapping_request: SCIMSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_update_serialize(
+ pm_uuid=pm_uuid,
+ scim_source_property_mapping_request=scim_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_update_serialize(
+ self,
+ pm_uuid,
+ scim_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_source_property_mapping_request is not None:
+ _body_params = scim_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/scim/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_scim_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_scim_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_scim_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this SCIM Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this SCIM Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_scim_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_scim_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/scim/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_create(
+ self,
+ telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TelegramSourcePropertyMapping:
+ """propertymappings_source_telegram_create
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param telegram_source_property_mapping_request: (required)
+ :type telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_create_serialize(
+ telegram_source_property_mapping_request=telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_create_with_http_info(
+ self,
+ telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TelegramSourcePropertyMapping]:
+ """propertymappings_source_telegram_create
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param telegram_source_property_mapping_request: (required)
+ :type telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_create_serialize(
+ telegram_source_property_mapping_request=telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_create_without_preload_content(
+ self,
+ telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_create
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param telegram_source_property_mapping_request: (required)
+ :type telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_create_serialize(
+ telegram_source_property_mapping_request=telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_create_serialize(
+ self,
+ telegram_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if telegram_source_property_mapping_request is not None:
+ _body_params = telegram_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/propertymappings/source/telegram/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_destroy(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """propertymappings_source_telegram_destroy
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_destroy_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """propertymappings_source_telegram_destroy
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_destroy_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_destroy
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_destroy_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_destroy_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/propertymappings/source/telegram/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_list(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedTelegramSourcePropertyMappingList:
+ """propertymappings_source_telegram_list
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTelegramSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_list_with_http_info(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedTelegramSourcePropertyMappingList]:
+ """propertymappings_source_telegram_list
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTelegramSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_list_without_preload_content(
+ self,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_list
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_list_serialize(
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedTelegramSourcePropertyMappingList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_list_serialize(
+ self,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/telegram/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_partial_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ patched_telegram_source_property_mapping_request: Optional[PatchedTelegramSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TelegramSourcePropertyMapping:
+ """propertymappings_source_telegram_partial_update
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_telegram_source_property_mapping_request:
+ :type patched_telegram_source_property_mapping_request: PatchedTelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_telegram_source_property_mapping_request=patched_telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_partial_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ patched_telegram_source_property_mapping_request: Optional[PatchedTelegramSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TelegramSourcePropertyMapping]:
+ """propertymappings_source_telegram_partial_update
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_telegram_source_property_mapping_request:
+ :type patched_telegram_source_property_mapping_request: PatchedTelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_telegram_source_property_mapping_request=patched_telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_partial_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ patched_telegram_source_property_mapping_request: Optional[PatchedTelegramSourcePropertyMappingRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_partial_update
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param patched_telegram_source_property_mapping_request:
+ :type patched_telegram_source_property_mapping_request: PatchedTelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_partial_update_serialize(
+ pm_uuid=pm_uuid,
+ patched_telegram_source_property_mapping_request=patched_telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_partial_update_serialize(
+ self,
+ pm_uuid,
+ patched_telegram_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_telegram_source_property_mapping_request is not None:
+ _body_params = patched_telegram_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/propertymappings/source/telegram/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_retrieve(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TelegramSourcePropertyMapping:
+ """propertymappings_source_telegram_retrieve
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_retrieve_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TelegramSourcePropertyMapping]:
+ """propertymappings_source_telegram_retrieve
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_retrieve_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_retrieve
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_retrieve_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_retrieve_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/telegram/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_update(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> TelegramSourcePropertyMapping:
+ """propertymappings_source_telegram_update
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param telegram_source_property_mapping_request: (required)
+ :type telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_update_serialize(
+ pm_uuid=pm_uuid,
+ telegram_source_property_mapping_request=telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_update_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[TelegramSourcePropertyMapping]:
+ """propertymappings_source_telegram_update
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param telegram_source_property_mapping_request: (required)
+ :type telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_update_serialize(
+ pm_uuid=pm_uuid,
+ telegram_source_property_mapping_request=telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_update_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_update
+
+ TelegramSourcePropertyMapping Viewset
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param telegram_source_property_mapping_request: (required)
+ :type telegram_source_property_mapping_request: TelegramSourcePropertyMappingRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_update_serialize(
+ pm_uuid=pm_uuid,
+ telegram_source_property_mapping_request=telegram_source_property_mapping_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "TelegramSourcePropertyMapping",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_update_serialize(
+ self,
+ pm_uuid,
+ telegram_source_property_mapping_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if telegram_source_property_mapping_request is not None:
+ _body_params = telegram_source_property_mapping_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/propertymappings/source/telegram/{pm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def propertymappings_source_telegram_used_by_list(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """propertymappings_source_telegram_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def propertymappings_source_telegram_used_by_list_with_http_info(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """propertymappings_source_telegram_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def propertymappings_source_telegram_used_by_list_without_preload_content(
+ self,
+ pm_uuid: Annotated[UUID, Field(description="A UUID string identifying this Telegram Source Property Mapping.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """propertymappings_source_telegram_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pm_uuid: A UUID string identifying this Telegram Source Property Mapping. (required)
+ :type pm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._propertymappings_source_telegram_used_by_list_serialize(
+ pm_uuid=pm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _propertymappings_source_telegram_used_by_list_serialize(
+ self,
+ pm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pm_uuid is not None:
+ _path_params['pm_uuid'] = pm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/propertymappings/source/telegram/{pm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/providers_api.py b/authentik_client/api/providers_api.py
new file mode 100644
index 000000000..d24c461f0
--- /dev/null
+++ b/authentik_client/api/providers_api.py
@@ -0,0 +1,37854 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr
+from typing import Any, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.digest_algorithm_enum import DigestAlgorithmEnum
+from authentik_client.models.google_workspace_provider import GoogleWorkspaceProvider
+from authentik_client.models.google_workspace_provider_group import GoogleWorkspaceProviderGroup
+from authentik_client.models.google_workspace_provider_group_request import GoogleWorkspaceProviderGroupRequest
+from authentik_client.models.google_workspace_provider_request import GoogleWorkspaceProviderRequest
+from authentik_client.models.google_workspace_provider_user import GoogleWorkspaceProviderUser
+from authentik_client.models.google_workspace_provider_user_request import GoogleWorkspaceProviderUserRequest
+from authentik_client.models.ldap_provider import LDAPProvider
+from authentik_client.models.ldap_provider_request import LDAPProviderRequest
+from authentik_client.models.microsoft_entra_provider import MicrosoftEntraProvider
+from authentik_client.models.microsoft_entra_provider_group import MicrosoftEntraProviderGroup
+from authentik_client.models.microsoft_entra_provider_group_request import MicrosoftEntraProviderGroupRequest
+from authentik_client.models.microsoft_entra_provider_request import MicrosoftEntraProviderRequest
+from authentik_client.models.microsoft_entra_provider_user import MicrosoftEntraProviderUser
+from authentik_client.models.microsoft_entra_provider_user_request import MicrosoftEntraProviderUserRequest
+from authentik_client.models.o_auth2_provider import OAuth2Provider
+from authentik_client.models.o_auth2_provider_request import OAuth2ProviderRequest
+from authentik_client.models.o_auth2_provider_setup_urls import OAuth2ProviderSetupURLs
+from authentik_client.models.paginated_google_workspace_provider_group_list import PaginatedGoogleWorkspaceProviderGroupList
+from authentik_client.models.paginated_google_workspace_provider_list import PaginatedGoogleWorkspaceProviderList
+from authentik_client.models.paginated_google_workspace_provider_user_list import PaginatedGoogleWorkspaceProviderUserList
+from authentik_client.models.paginated_ldap_provider_list import PaginatedLDAPProviderList
+from authentik_client.models.paginated_microsoft_entra_provider_group_list import PaginatedMicrosoftEntraProviderGroupList
+from authentik_client.models.paginated_microsoft_entra_provider_list import PaginatedMicrosoftEntraProviderList
+from authentik_client.models.paginated_microsoft_entra_provider_user_list import PaginatedMicrosoftEntraProviderUserList
+from authentik_client.models.paginated_o_auth2_provider_list import PaginatedOAuth2ProviderList
+from authentik_client.models.paginated_provider_list import PaginatedProviderList
+from authentik_client.models.paginated_proxy_provider_list import PaginatedProxyProviderList
+from authentik_client.models.paginated_rac_provider_list import PaginatedRACProviderList
+from authentik_client.models.paginated_radius_provider_list import PaginatedRadiusProviderList
+from authentik_client.models.paginated_saml_provider_list import PaginatedSAMLProviderList
+from authentik_client.models.paginated_scim_provider_group_list import PaginatedSCIMProviderGroupList
+from authentik_client.models.paginated_scim_provider_list import PaginatedSCIMProviderList
+from authentik_client.models.paginated_scim_provider_user_list import PaginatedSCIMProviderUserList
+from authentik_client.models.paginated_ssf_provider_list import PaginatedSSFProviderList
+from authentik_client.models.paginated_ws_federation_provider_list import PaginatedWSFederationProviderList
+from authentik_client.models.patched_google_workspace_provider_request import PatchedGoogleWorkspaceProviderRequest
+from authentik_client.models.patched_ldap_provider_request import PatchedLDAPProviderRequest
+from authentik_client.models.patched_microsoft_entra_provider_request import PatchedMicrosoftEntraProviderRequest
+from authentik_client.models.patched_o_auth2_provider_request import PatchedOAuth2ProviderRequest
+from authentik_client.models.patched_proxy_provider_request import PatchedProxyProviderRequest
+from authentik_client.models.patched_rac_provider_request import PatchedRACProviderRequest
+from authentik_client.models.patched_radius_provider_request import PatchedRadiusProviderRequest
+from authentik_client.models.patched_saml_provider_request import PatchedSAMLProviderRequest
+from authentik_client.models.patched_scim_provider_request import PatchedSCIMProviderRequest
+from authentik_client.models.patched_ssf_provider_request import PatchedSSFProviderRequest
+from authentik_client.models.patched_ws_federation_provider_request import PatchedWSFederationProviderRequest
+from authentik_client.models.property_mapping_preview import PropertyMappingPreview
+from authentik_client.models.provider import Provider
+from authentik_client.models.proxy_provider import ProxyProvider
+from authentik_client.models.proxy_provider_request import ProxyProviderRequest
+from authentik_client.models.rac_provider import RACProvider
+from authentik_client.models.rac_provider_request import RACProviderRequest
+from authentik_client.models.radius_provider import RadiusProvider
+from authentik_client.models.radius_provider_request import RadiusProviderRequest
+from authentik_client.models.saml_metadata import SAMLMetadata
+from authentik_client.models.saml_name_id_policy_enum import SAMLNameIDPolicyEnum
+from authentik_client.models.saml_provider import SAMLProvider
+from authentik_client.models.saml_provider_request import SAMLProviderRequest
+from authentik_client.models.scim_provider import SCIMProvider
+from authentik_client.models.scim_provider_group import SCIMProviderGroup
+from authentik_client.models.scim_provider_group_request import SCIMProviderGroupRequest
+from authentik_client.models.scim_provider_request import SCIMProviderRequest
+from authentik_client.models.scim_provider_user import SCIMProviderUser
+from authentik_client.models.scim_provider_user_request import SCIMProviderUserRequest
+from authentik_client.models.ssf_provider import SSFProvider
+from authentik_client.models.ssf_provider_request import SSFProviderRequest
+from authentik_client.models.signature_algorithm_enum import SignatureAlgorithmEnum
+from authentik_client.models.sync_object_request import SyncObjectRequest
+from authentik_client.models.sync_object_result import SyncObjectResult
+from authentik_client.models.sync_status import SyncStatus
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.ws_federation_provider import WSFederationProvider
+from authentik_client.models.ws_federation_provider_request import WSFederationProviderRequest
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class ProvidersApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def providers_all_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_all_destroy
+
+ Provider Viewset
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_all_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_all_destroy
+
+ Provider Viewset
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_all_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_all_destroy
+
+ Provider Viewset
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_all_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/all/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_all_list(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ backchannel: Annotated[Optional[StrictBool], Field(description="When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedProviderList:
+ """providers_all_list
+
+ Provider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param backchannel: When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded
+ :type backchannel: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_list_serialize(
+ application__isnull=application__isnull,
+ backchannel=backchannel,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_all_list_with_http_info(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ backchannel: Annotated[Optional[StrictBool], Field(description="When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedProviderList]:
+ """providers_all_list
+
+ Provider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param backchannel: When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded
+ :type backchannel: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_list_serialize(
+ application__isnull=application__isnull,
+ backchannel=backchannel,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_all_list_without_preload_content(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ backchannel: Annotated[Optional[StrictBool], Field(description="When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded")] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_all_list
+
+ Provider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param backchannel: When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded
+ :type backchannel: bool
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_list_serialize(
+ application__isnull=application__isnull,
+ backchannel=backchannel,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_all_list_serialize(
+ self,
+ application__isnull,
+ backchannel,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application__isnull is not None:
+
+ _query_params.append(('application__isnull', application__isnull))
+
+ if backchannel is not None:
+
+ _query_params.append(('backchannel', backchannel))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_all_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Provider:
+ """providers_all_retrieve
+
+ Provider Viewset
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_all_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Provider]:
+ """providers_all_retrieve
+
+ Provider Viewset
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_all_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_all_retrieve
+
+ Provider Viewset
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_all_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/all/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_all_types_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """providers_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_all_types_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """providers_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_all_types_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_all_types_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/all/types/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_all_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_all_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_all_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_all_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_all_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/all/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_create(
+ self,
+ google_workspace_provider_request: GoogleWorkspaceProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProvider:
+ """providers_google_workspace_create
+
+ GoogleWorkspaceProvider Viewset
+
+ :param google_workspace_provider_request: (required)
+ :type google_workspace_provider_request: GoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_create_serialize(
+ google_workspace_provider_request=google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_create_with_http_info(
+ self,
+ google_workspace_provider_request: GoogleWorkspaceProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProvider]:
+ """providers_google_workspace_create
+
+ GoogleWorkspaceProvider Viewset
+
+ :param google_workspace_provider_request: (required)
+ :type google_workspace_provider_request: GoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_create_serialize(
+ google_workspace_provider_request=google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_create_without_preload_content(
+ self,
+ google_workspace_provider_request: GoogleWorkspaceProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_create
+
+ GoogleWorkspaceProvider Viewset
+
+ :param google_workspace_provider_request: (required)
+ :type google_workspace_provider_request: GoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_create_serialize(
+ google_workspace_provider_request=google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_create_serialize(
+ self,
+ google_workspace_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_workspace_provider_request is not None:
+ _body_params = google_workspace_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/google_workspace/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_google_workspace_destroy
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_google_workspace_destroy
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_destroy
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/google_workspace/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_groups_create(
+ self,
+ google_workspace_provider_group_request: GoogleWorkspaceProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderGroup:
+ """providers_google_workspace_groups_create
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param google_workspace_provider_group_request: (required)
+ :type google_workspace_provider_group_request: GoogleWorkspaceProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_create_serialize(
+ google_workspace_provider_group_request=google_workspace_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_groups_create_with_http_info(
+ self,
+ google_workspace_provider_group_request: GoogleWorkspaceProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderGroup]:
+ """providers_google_workspace_groups_create
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param google_workspace_provider_group_request: (required)
+ :type google_workspace_provider_group_request: GoogleWorkspaceProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_create_serialize(
+ google_workspace_provider_group_request=google_workspace_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_groups_create_without_preload_content(
+ self,
+ google_workspace_provider_group_request: GoogleWorkspaceProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_groups_create
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param google_workspace_provider_group_request: (required)
+ :type google_workspace_provider_group_request: GoogleWorkspaceProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_create_serialize(
+ google_workspace_provider_group_request=google_workspace_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_groups_create_serialize(
+ self,
+ google_workspace_provider_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_workspace_provider_group_request is not None:
+ _body_params = google_workspace_provider_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/google_workspace_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_groups_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_google_workspace_groups_destroy
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_groups_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_google_workspace_groups_destroy
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_groups_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_groups_destroy
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_groups_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/google_workspace_groups/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_groups_list(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleWorkspaceProviderGroupList:
+ """providers_google_workspace_groups_list
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_groups_list_with_http_info(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleWorkspaceProviderGroupList]:
+ """providers_google_workspace_groups_list
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_groups_list_without_preload_content(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_groups_list
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_groups_list_serialize(
+ self,
+ group__group_uuid,
+ group__name,
+ ordering,
+ page,
+ page_size,
+ provider__id,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if group__group_uuid is not None:
+
+ _query_params.append(('group__group_uuid', group__group_uuid))
+
+ if group__name is not None:
+
+ _query_params.append(('group__name', group__name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider__id is not None:
+
+ _query_params.append(('provider__id', provider__id))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_groups_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderGroup:
+ """providers_google_workspace_groups_retrieve
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_groups_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderGroup]:
+ """providers_google_workspace_groups_retrieve
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_groups_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_groups_retrieve
+
+ GoogleWorkspaceProviderGroup Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_groups_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace_groups/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_groups_used_by_list(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_google_workspace_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_groups_used_by_list_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_google_workspace_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_groups_used_by_list_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Google Workspace Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_groups_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace_groups/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_list(
+ self,
+ delegated_subject: Optional[StrictStr] = None,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ filter_group: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleWorkspaceProviderList:
+ """providers_google_workspace_list
+
+ GoogleWorkspaceProvider Viewset
+
+ :param delegated_subject:
+ :type delegated_subject: str
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param filter_group:
+ :type filter_group: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_list_serialize(
+ delegated_subject=delegated_subject,
+ exclude_users_service_account=exclude_users_service_account,
+ filter_group=filter_group,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_list_with_http_info(
+ self,
+ delegated_subject: Optional[StrictStr] = None,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ filter_group: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleWorkspaceProviderList]:
+ """providers_google_workspace_list
+
+ GoogleWorkspaceProvider Viewset
+
+ :param delegated_subject:
+ :type delegated_subject: str
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param filter_group:
+ :type filter_group: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_list_serialize(
+ delegated_subject=delegated_subject,
+ exclude_users_service_account=exclude_users_service_account,
+ filter_group=filter_group,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_list_without_preload_content(
+ self,
+ delegated_subject: Optional[StrictStr] = None,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ filter_group: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_list
+
+ GoogleWorkspaceProvider Viewset
+
+ :param delegated_subject:
+ :type delegated_subject: str
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param filter_group:
+ :type filter_group: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_list_serialize(
+ delegated_subject=delegated_subject,
+ exclude_users_service_account=exclude_users_service_account,
+ filter_group=filter_group,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_list_serialize(
+ self,
+ delegated_subject,
+ exclude_users_service_account,
+ filter_group,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if delegated_subject is not None:
+
+ _query_params.append(('delegated_subject', delegated_subject))
+
+ if exclude_users_service_account is not None:
+
+ _query_params.append(('exclude_users_service_account', exclude_users_service_account))
+
+ if filter_group is not None:
+
+ _query_params.append(('filter_group', filter_group))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ patched_google_workspace_provider_request: Optional[PatchedGoogleWorkspaceProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProvider:
+ """providers_google_workspace_partial_update
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param patched_google_workspace_provider_request:
+ :type patched_google_workspace_provider_request: PatchedGoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_partial_update_serialize(
+ id=id,
+ patched_google_workspace_provider_request=patched_google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ patched_google_workspace_provider_request: Optional[PatchedGoogleWorkspaceProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProvider]:
+ """providers_google_workspace_partial_update
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param patched_google_workspace_provider_request:
+ :type patched_google_workspace_provider_request: PatchedGoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_partial_update_serialize(
+ id=id,
+ patched_google_workspace_provider_request=patched_google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ patched_google_workspace_provider_request: Optional[PatchedGoogleWorkspaceProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_partial_update
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param patched_google_workspace_provider_request:
+ :type patched_google_workspace_provider_request: PatchedGoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_partial_update_serialize(
+ id=id,
+ patched_google_workspace_provider_request=patched_google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_partial_update_serialize(
+ self,
+ id,
+ patched_google_workspace_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_google_workspace_provider_request is not None:
+ _body_params = patched_google_workspace_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/google_workspace/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProvider:
+ """providers_google_workspace_retrieve
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProvider]:
+ """providers_google_workspace_retrieve
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_retrieve
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_sync_object_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SyncObjectResult:
+ """providers_google_workspace_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_sync_object_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SyncObjectResult]:
+ """providers_google_workspace_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_sync_object_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_sync_object_create_serialize(
+ self,
+ id,
+ sync_object_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if sync_object_request is not None:
+ _body_params = sync_object_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/google_workspace/{id}/sync/object/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_sync_status_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SyncStatus:
+ """providers_google_workspace_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_sync_status_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SyncStatus]:
+ """providers_google_workspace_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_sync_status_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_sync_status_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace/{id}/sync/status/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ google_workspace_provider_request: GoogleWorkspaceProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProvider:
+ """providers_google_workspace_update
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param google_workspace_provider_request: (required)
+ :type google_workspace_provider_request: GoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_update_serialize(
+ id=id,
+ google_workspace_provider_request=google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ google_workspace_provider_request: GoogleWorkspaceProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProvider]:
+ """providers_google_workspace_update
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param google_workspace_provider_request: (required)
+ :type google_workspace_provider_request: GoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_update_serialize(
+ id=id,
+ google_workspace_provider_request=google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ google_workspace_provider_request: GoogleWorkspaceProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_update
+
+ GoogleWorkspaceProvider Viewset
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param google_workspace_provider_request: (required)
+ :type google_workspace_provider_request: GoogleWorkspaceProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_update_serialize(
+ id=id,
+ google_workspace_provider_request=google_workspace_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_update_serialize(
+ self,
+ id,
+ google_workspace_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_workspace_provider_request is not None:
+ _body_params = google_workspace_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/google_workspace/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_google_workspace_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_google_workspace_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Google Workspace Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Google Workspace Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_users_create(
+ self,
+ google_workspace_provider_user_request: GoogleWorkspaceProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderUser:
+ """providers_google_workspace_users_create
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param google_workspace_provider_user_request: (required)
+ :type google_workspace_provider_user_request: GoogleWorkspaceProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_create_serialize(
+ google_workspace_provider_user_request=google_workspace_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_users_create_with_http_info(
+ self,
+ google_workspace_provider_user_request: GoogleWorkspaceProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderUser]:
+ """providers_google_workspace_users_create
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param google_workspace_provider_user_request: (required)
+ :type google_workspace_provider_user_request: GoogleWorkspaceProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_create_serialize(
+ google_workspace_provider_user_request=google_workspace_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_users_create_without_preload_content(
+ self,
+ google_workspace_provider_user_request: GoogleWorkspaceProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_users_create
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param google_workspace_provider_user_request: (required)
+ :type google_workspace_provider_user_request: GoogleWorkspaceProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_create_serialize(
+ google_workspace_provider_user_request=google_workspace_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GoogleWorkspaceProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_users_create_serialize(
+ self,
+ google_workspace_provider_user_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if google_workspace_provider_user_request is not None:
+ _body_params = google_workspace_provider_user_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/google_workspace_users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_users_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_google_workspace_users_destroy
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_users_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_google_workspace_users_destroy
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_users_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_users_destroy
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_users_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/google_workspace_users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_users_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGoogleWorkspaceProviderUserList:
+ """providers_google_workspace_users_list
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_users_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGoogleWorkspaceProviderUserList]:
+ """providers_google_workspace_users_list
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_users_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_users_list
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGoogleWorkspaceProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_users_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ provider__id,
+ search,
+ user__id,
+ user__username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider__id is not None:
+
+ _query_params.append(('provider__id', provider__id))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user__id is not None:
+
+ _query_params.append(('user__id', user__id))
+
+ if user__username is not None:
+
+ _query_params.append(('user__username', user__username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace_users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_users_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GoogleWorkspaceProviderUser:
+ """providers_google_workspace_users_retrieve
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_users_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GoogleWorkspaceProviderUser]:
+ """providers_google_workspace_users_retrieve
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_users_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_users_retrieve
+
+ GoogleWorkspaceProviderUser Viewset
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GoogleWorkspaceProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_users_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace_users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_google_workspace_users_used_by_list(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_google_workspace_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_google_workspace_users_used_by_list_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_google_workspace_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_google_workspace_users_used_by_list_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Google Workspace Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_google_workspace_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Google Workspace Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_google_workspace_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_google_workspace_users_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/google_workspace_users/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_create(
+ self,
+ ldap_provider_request: LDAPProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPProvider:
+ """providers_ldap_create
+
+ LDAPProvider Viewset
+
+ :param ldap_provider_request: (required)
+ :type ldap_provider_request: LDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_create_serialize(
+ ldap_provider_request=ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_create_with_http_info(
+ self,
+ ldap_provider_request: LDAPProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPProvider]:
+ """providers_ldap_create
+
+ LDAPProvider Viewset
+
+ :param ldap_provider_request: (required)
+ :type ldap_provider_request: LDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_create_serialize(
+ ldap_provider_request=ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_create_without_preload_content(
+ self,
+ ldap_provider_request: LDAPProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_create
+
+ LDAPProvider Viewset
+
+ :param ldap_provider_request: (required)
+ :type ldap_provider_request: LDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_create_serialize(
+ ldap_provider_request=ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_create_serialize(
+ self,
+ ldap_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ldap_provider_request is not None:
+ _body_params = ldap_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_ldap_destroy
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_ldap_destroy
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_destroy
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_list(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ base_dn__iexact: Optional[StrictStr] = None,
+ certificate__kp_uuid__iexact: Optional[UUID] = None,
+ certificate__name__iexact: Optional[StrictStr] = None,
+ gid_start_number__iexact: Optional[StrictInt] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ tls_server_name__iexact: Optional[StrictStr] = None,
+ uid_start_number__iexact: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedLDAPProviderList:
+ """providers_ldap_list
+
+ LDAPProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param base_dn__iexact:
+ :type base_dn__iexact: str
+ :param certificate__kp_uuid__iexact:
+ :type certificate__kp_uuid__iexact: UUID
+ :param certificate__name__iexact:
+ :type certificate__name__iexact: str
+ :param gid_start_number__iexact:
+ :type gid_start_number__iexact: int
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param tls_server_name__iexact:
+ :type tls_server_name__iexact: str
+ :param uid_start_number__iexact:
+ :type uid_start_number__iexact: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ base_dn__iexact=base_dn__iexact,
+ certificate__kp_uuid__iexact=certificate__kp_uuid__iexact,
+ certificate__name__iexact=certificate__name__iexact,
+ gid_start_number__iexact=gid_start_number__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ tls_server_name__iexact=tls_server_name__iexact,
+ uid_start_number__iexact=uid_start_number__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_list_with_http_info(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ base_dn__iexact: Optional[StrictStr] = None,
+ certificate__kp_uuid__iexact: Optional[UUID] = None,
+ certificate__name__iexact: Optional[StrictStr] = None,
+ gid_start_number__iexact: Optional[StrictInt] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ tls_server_name__iexact: Optional[StrictStr] = None,
+ uid_start_number__iexact: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedLDAPProviderList]:
+ """providers_ldap_list
+
+ LDAPProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param base_dn__iexact:
+ :type base_dn__iexact: str
+ :param certificate__kp_uuid__iexact:
+ :type certificate__kp_uuid__iexact: UUID
+ :param certificate__name__iexact:
+ :type certificate__name__iexact: str
+ :param gid_start_number__iexact:
+ :type gid_start_number__iexact: int
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param tls_server_name__iexact:
+ :type tls_server_name__iexact: str
+ :param uid_start_number__iexact:
+ :type uid_start_number__iexact: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ base_dn__iexact=base_dn__iexact,
+ certificate__kp_uuid__iexact=certificate__kp_uuid__iexact,
+ certificate__name__iexact=certificate__name__iexact,
+ gid_start_number__iexact=gid_start_number__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ tls_server_name__iexact=tls_server_name__iexact,
+ uid_start_number__iexact=uid_start_number__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_list_without_preload_content(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ base_dn__iexact: Optional[StrictStr] = None,
+ certificate__kp_uuid__iexact: Optional[UUID] = None,
+ certificate__name__iexact: Optional[StrictStr] = None,
+ gid_start_number__iexact: Optional[StrictInt] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ tls_server_name__iexact: Optional[StrictStr] = None,
+ uid_start_number__iexact: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_list
+
+ LDAPProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param base_dn__iexact:
+ :type base_dn__iexact: str
+ :param certificate__kp_uuid__iexact:
+ :type certificate__kp_uuid__iexact: UUID
+ :param certificate__name__iexact:
+ :type certificate__name__iexact: str
+ :param gid_start_number__iexact:
+ :type gid_start_number__iexact: int
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param tls_server_name__iexact:
+ :type tls_server_name__iexact: str
+ :param uid_start_number__iexact:
+ :type uid_start_number__iexact: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ base_dn__iexact=base_dn__iexact,
+ certificate__kp_uuid__iexact=certificate__kp_uuid__iexact,
+ certificate__name__iexact=certificate__name__iexact,
+ gid_start_number__iexact=gid_start_number__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ tls_server_name__iexact=tls_server_name__iexact,
+ uid_start_number__iexact=uid_start_number__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedLDAPProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_list_serialize(
+ self,
+ application__isnull,
+ authorization_flow__slug__iexact,
+ base_dn__iexact,
+ certificate__kp_uuid__iexact,
+ certificate__name__iexact,
+ gid_start_number__iexact,
+ name__iexact,
+ ordering,
+ page,
+ page_size,
+ search,
+ tls_server_name__iexact,
+ uid_start_number__iexact,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application__isnull is not None:
+
+ _query_params.append(('application__isnull', application__isnull))
+
+ if authorization_flow__slug__iexact is not None:
+
+ _query_params.append(('authorization_flow__slug__iexact', authorization_flow__slug__iexact))
+
+ if base_dn__iexact is not None:
+
+ _query_params.append(('base_dn__iexact', base_dn__iexact))
+
+ if certificate__kp_uuid__iexact is not None:
+
+ _query_params.append(('certificate__kp_uuid__iexact', certificate__kp_uuid__iexact))
+
+ if certificate__name__iexact is not None:
+
+ _query_params.append(('certificate__name__iexact', certificate__name__iexact))
+
+ if gid_start_number__iexact is not None:
+
+ _query_params.append(('gid_start_number__iexact', gid_start_number__iexact))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if tls_server_name__iexact is not None:
+
+ _query_params.append(('tls_server_name__iexact', tls_server_name__iexact))
+
+ if uid_start_number__iexact is not None:
+
+ _query_params.append(('uid_start_number__iexact', uid_start_number__iexact))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ patched_ldap_provider_request: Optional[PatchedLDAPProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPProvider:
+ """providers_ldap_partial_update
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param patched_ldap_provider_request:
+ :type patched_ldap_provider_request: PatchedLDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_partial_update_serialize(
+ id=id,
+ patched_ldap_provider_request=patched_ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ patched_ldap_provider_request: Optional[PatchedLDAPProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPProvider]:
+ """providers_ldap_partial_update
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param patched_ldap_provider_request:
+ :type patched_ldap_provider_request: PatchedLDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_partial_update_serialize(
+ id=id,
+ patched_ldap_provider_request=patched_ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ patched_ldap_provider_request: Optional[PatchedLDAPProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_partial_update
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param patched_ldap_provider_request:
+ :type patched_ldap_provider_request: PatchedLDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_partial_update_serialize(
+ id=id,
+ patched_ldap_provider_request=patched_ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_partial_update_serialize(
+ self,
+ id,
+ patched_ldap_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_ldap_provider_request is not None:
+ _body_params = patched_ldap_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPProvider:
+ """providers_ldap_retrieve
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPProvider]:
+ """providers_ldap_retrieve
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_retrieve
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ ldap_provider_request: LDAPProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> LDAPProvider:
+ """providers_ldap_update
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param ldap_provider_request: (required)
+ :type ldap_provider_request: LDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_update_serialize(
+ id=id,
+ ldap_provider_request=ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ ldap_provider_request: LDAPProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[LDAPProvider]:
+ """providers_ldap_update
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param ldap_provider_request: (required)
+ :type ldap_provider_request: LDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_update_serialize(
+ id=id,
+ ldap_provider_request=ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ ldap_provider_request: LDAPProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_update
+
+ LDAPProvider Viewset
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param ldap_provider_request: (required)
+ :type ldap_provider_request: LDAPProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_update_serialize(
+ id=id,
+ ldap_provider_request=ldap_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "LDAPProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_update_serialize(
+ self,
+ id,
+ ldap_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ldap_provider_request is not None:
+ _body_params = ldap_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ldap_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ldap_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ldap_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this LDAP Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this LDAP Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ldap_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ldap_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/ldap/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_create(
+ self,
+ microsoft_entra_provider_request: MicrosoftEntraProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProvider:
+ """providers_microsoft_entra_create
+
+ MicrosoftEntraProvider Viewset
+
+ :param microsoft_entra_provider_request: (required)
+ :type microsoft_entra_provider_request: MicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_create_serialize(
+ microsoft_entra_provider_request=microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_create_with_http_info(
+ self,
+ microsoft_entra_provider_request: MicrosoftEntraProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProvider]:
+ """providers_microsoft_entra_create
+
+ MicrosoftEntraProvider Viewset
+
+ :param microsoft_entra_provider_request: (required)
+ :type microsoft_entra_provider_request: MicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_create_serialize(
+ microsoft_entra_provider_request=microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_create_without_preload_content(
+ self,
+ microsoft_entra_provider_request: MicrosoftEntraProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_create
+
+ MicrosoftEntraProvider Viewset
+
+ :param microsoft_entra_provider_request: (required)
+ :type microsoft_entra_provider_request: MicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_create_serialize(
+ microsoft_entra_provider_request=microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_create_serialize(
+ self,
+ microsoft_entra_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if microsoft_entra_provider_request is not None:
+ _body_params = microsoft_entra_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/microsoft_entra/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_microsoft_entra_destroy
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_microsoft_entra_destroy
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_destroy
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/microsoft_entra/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_create(
+ self,
+ microsoft_entra_provider_group_request: MicrosoftEntraProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderGroup:
+ """providers_microsoft_entra_groups_create
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param microsoft_entra_provider_group_request: (required)
+ :type microsoft_entra_provider_group_request: MicrosoftEntraProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_create_serialize(
+ microsoft_entra_provider_group_request=microsoft_entra_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_create_with_http_info(
+ self,
+ microsoft_entra_provider_group_request: MicrosoftEntraProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderGroup]:
+ """providers_microsoft_entra_groups_create
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param microsoft_entra_provider_group_request: (required)
+ :type microsoft_entra_provider_group_request: MicrosoftEntraProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_create_serialize(
+ microsoft_entra_provider_group_request=microsoft_entra_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_create_without_preload_content(
+ self,
+ microsoft_entra_provider_group_request: MicrosoftEntraProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_groups_create
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param microsoft_entra_provider_group_request: (required)
+ :type microsoft_entra_provider_group_request: MicrosoftEntraProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_create_serialize(
+ microsoft_entra_provider_group_request=microsoft_entra_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_groups_create_serialize(
+ self,
+ microsoft_entra_provider_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if microsoft_entra_provider_group_request is not None:
+ _body_params = microsoft_entra_provider_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/microsoft_entra_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_microsoft_entra_groups_destroy
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_microsoft_entra_groups_destroy
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_groups_destroy
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_groups_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/microsoft_entra_groups/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_list(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedMicrosoftEntraProviderGroupList:
+ """providers_microsoft_entra_groups_list
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_list_with_http_info(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedMicrosoftEntraProviderGroupList]:
+ """providers_microsoft_entra_groups_list
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_list_without_preload_content(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_groups_list
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_groups_list_serialize(
+ self,
+ group__group_uuid,
+ group__name,
+ ordering,
+ page,
+ page_size,
+ provider__id,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if group__group_uuid is not None:
+
+ _query_params.append(('group__group_uuid', group__group_uuid))
+
+ if group__name is not None:
+
+ _query_params.append(('group__name', group__name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider__id is not None:
+
+ _query_params.append(('provider__id', provider__id))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderGroup:
+ """providers_microsoft_entra_groups_retrieve
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderGroup]:
+ """providers_microsoft_entra_groups_retrieve
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_groups_retrieve
+
+ MicrosoftEntraProviderGroup Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_groups_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra_groups/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_used_by_list(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_microsoft_entra_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_used_by_list_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_microsoft_entra_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_groups_used_by_list_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider Group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Microsoft Entra Provider Group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_groups_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra_groups/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_list(
+ self,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ filter_group: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedMicrosoftEntraProviderList:
+ """providers_microsoft_entra_list
+
+ MicrosoftEntraProvider Viewset
+
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param filter_group:
+ :type filter_group: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_list_serialize(
+ exclude_users_service_account=exclude_users_service_account,
+ filter_group=filter_group,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_list_with_http_info(
+ self,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ filter_group: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedMicrosoftEntraProviderList]:
+ """providers_microsoft_entra_list
+
+ MicrosoftEntraProvider Viewset
+
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param filter_group:
+ :type filter_group: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_list_serialize(
+ exclude_users_service_account=exclude_users_service_account,
+ filter_group=filter_group,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_list_without_preload_content(
+ self,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ filter_group: Optional[UUID] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_list
+
+ MicrosoftEntraProvider Viewset
+
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param filter_group:
+ :type filter_group: UUID
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_list_serialize(
+ exclude_users_service_account=exclude_users_service_account,
+ filter_group=filter_group,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_list_serialize(
+ self,
+ exclude_users_service_account,
+ filter_group,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if exclude_users_service_account is not None:
+
+ _query_params.append(('exclude_users_service_account', exclude_users_service_account))
+
+ if filter_group is not None:
+
+ _query_params.append(('filter_group', filter_group))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ patched_microsoft_entra_provider_request: Optional[PatchedMicrosoftEntraProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProvider:
+ """providers_microsoft_entra_partial_update
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param patched_microsoft_entra_provider_request:
+ :type patched_microsoft_entra_provider_request: PatchedMicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_partial_update_serialize(
+ id=id,
+ patched_microsoft_entra_provider_request=patched_microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ patched_microsoft_entra_provider_request: Optional[PatchedMicrosoftEntraProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProvider]:
+ """providers_microsoft_entra_partial_update
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param patched_microsoft_entra_provider_request:
+ :type patched_microsoft_entra_provider_request: PatchedMicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_partial_update_serialize(
+ id=id,
+ patched_microsoft_entra_provider_request=patched_microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ patched_microsoft_entra_provider_request: Optional[PatchedMicrosoftEntraProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_partial_update
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param patched_microsoft_entra_provider_request:
+ :type patched_microsoft_entra_provider_request: PatchedMicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_partial_update_serialize(
+ id=id,
+ patched_microsoft_entra_provider_request=patched_microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_partial_update_serialize(
+ self,
+ id,
+ patched_microsoft_entra_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_microsoft_entra_provider_request is not None:
+ _body_params = patched_microsoft_entra_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/microsoft_entra/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProvider:
+ """providers_microsoft_entra_retrieve
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProvider]:
+ """providers_microsoft_entra_retrieve
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_retrieve
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_sync_object_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SyncObjectResult:
+ """providers_microsoft_entra_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_sync_object_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SyncObjectResult]:
+ """providers_microsoft_entra_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_sync_object_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_sync_object_create_serialize(
+ self,
+ id,
+ sync_object_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if sync_object_request is not None:
+ _body_params = sync_object_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/microsoft_entra/{id}/sync/object/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_sync_status_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SyncStatus:
+ """providers_microsoft_entra_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_sync_status_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SyncStatus]:
+ """providers_microsoft_entra_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_sync_status_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_sync_status_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra/{id}/sync/status/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ microsoft_entra_provider_request: MicrosoftEntraProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProvider:
+ """providers_microsoft_entra_update
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param microsoft_entra_provider_request: (required)
+ :type microsoft_entra_provider_request: MicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_update_serialize(
+ id=id,
+ microsoft_entra_provider_request=microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ microsoft_entra_provider_request: MicrosoftEntraProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProvider]:
+ """providers_microsoft_entra_update
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param microsoft_entra_provider_request: (required)
+ :type microsoft_entra_provider_request: MicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_update_serialize(
+ id=id,
+ microsoft_entra_provider_request=microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ microsoft_entra_provider_request: MicrosoftEntraProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_update
+
+ MicrosoftEntraProvider Viewset
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param microsoft_entra_provider_request: (required)
+ :type microsoft_entra_provider_request: MicrosoftEntraProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_update_serialize(
+ id=id,
+ microsoft_entra_provider_request=microsoft_entra_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_update_serialize(
+ self,
+ id,
+ microsoft_entra_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if microsoft_entra_provider_request is not None:
+ _body_params = microsoft_entra_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/microsoft_entra/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_microsoft_entra_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_microsoft_entra_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Microsoft Entra Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Microsoft Entra Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_users_create(
+ self,
+ microsoft_entra_provider_user_request: MicrosoftEntraProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderUser:
+ """providers_microsoft_entra_users_create
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param microsoft_entra_provider_user_request: (required)
+ :type microsoft_entra_provider_user_request: MicrosoftEntraProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_create_serialize(
+ microsoft_entra_provider_user_request=microsoft_entra_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_users_create_with_http_info(
+ self,
+ microsoft_entra_provider_user_request: MicrosoftEntraProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderUser]:
+ """providers_microsoft_entra_users_create
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param microsoft_entra_provider_user_request: (required)
+ :type microsoft_entra_provider_user_request: MicrosoftEntraProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_create_serialize(
+ microsoft_entra_provider_user_request=microsoft_entra_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_users_create_without_preload_content(
+ self,
+ microsoft_entra_provider_user_request: MicrosoftEntraProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_users_create
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param microsoft_entra_provider_user_request: (required)
+ :type microsoft_entra_provider_user_request: MicrosoftEntraProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_create_serialize(
+ microsoft_entra_provider_user_request=microsoft_entra_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "MicrosoftEntraProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_users_create_serialize(
+ self,
+ microsoft_entra_provider_user_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if microsoft_entra_provider_user_request is not None:
+ _body_params = microsoft_entra_provider_user_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/microsoft_entra_users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_users_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_microsoft_entra_users_destroy
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_users_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_microsoft_entra_users_destroy
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_users_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_users_destroy
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_users_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/microsoft_entra_users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_users_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedMicrosoftEntraProviderUserList:
+ """providers_microsoft_entra_users_list
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_users_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedMicrosoftEntraProviderUserList]:
+ """providers_microsoft_entra_users_list
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_users_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_users_list
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedMicrosoftEntraProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_users_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ provider__id,
+ search,
+ user__id,
+ user__username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider__id is not None:
+
+ _query_params.append(('provider__id', provider__id))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user__id is not None:
+
+ _query_params.append(('user__id', user__id))
+
+ if user__username is not None:
+
+ _query_params.append(('user__username', user__username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra_users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_users_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> MicrosoftEntraProviderUser:
+ """providers_microsoft_entra_users_retrieve
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_users_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[MicrosoftEntraProviderUser]:
+ """providers_microsoft_entra_users_retrieve
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_users_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_users_retrieve
+
+ MicrosoftEntraProviderUser Viewset
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "MicrosoftEntraProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_users_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra_users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_microsoft_entra_users_used_by_list(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_microsoft_entra_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_microsoft_entra_users_used_by_list_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_microsoft_entra_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_microsoft_entra_users_used_by_list_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Microsoft Entra Provider User.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_microsoft_entra_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this Microsoft Entra Provider User. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_microsoft_entra_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_microsoft_entra_users_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/microsoft_entra_users/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_create(
+ self,
+ o_auth2_provider_request: OAuth2ProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuth2Provider:
+ """providers_oauth2_create
+
+ OAuth2Provider Viewset
+
+ :param o_auth2_provider_request: (required)
+ :type o_auth2_provider_request: OAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_create_serialize(
+ o_auth2_provider_request=o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_create_with_http_info(
+ self,
+ o_auth2_provider_request: OAuth2ProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuth2Provider]:
+ """providers_oauth2_create
+
+ OAuth2Provider Viewset
+
+ :param o_auth2_provider_request: (required)
+ :type o_auth2_provider_request: OAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_create_serialize(
+ o_auth2_provider_request=o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_create_without_preload_content(
+ self,
+ o_auth2_provider_request: OAuth2ProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_create
+
+ OAuth2Provider Viewset
+
+ :param o_auth2_provider_request: (required)
+ :type o_auth2_provider_request: OAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_create_serialize(
+ o_auth2_provider_request=o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_create_serialize(
+ self,
+ o_auth2_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if o_auth2_provider_request is not None:
+ _body_params = o_auth2_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/oauth2/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_oauth2_destroy
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_oauth2_destroy
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_destroy
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/oauth2/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_list(
+ self,
+ access_code_validity: Optional[StrictStr] = None,
+ access_token_validity: Optional[StrictStr] = None,
+ application: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ client_id: Optional[StrictStr] = None,
+ client_type: Optional[Any] = None,
+ include_claims_in_id_token: Optional[StrictBool] = None,
+ issuer_mode: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ refresh_token_validity: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ signing_key: Optional[UUID] = None,
+ sub_mode: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedOAuth2ProviderList:
+ """providers_oauth2_list
+
+ OAuth2Provider Viewset
+
+ :param access_code_validity:
+ :type access_code_validity: str
+ :param access_token_validity:
+ :type access_token_validity: str
+ :param application:
+ :type application: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param client_id:
+ :type client_id: str
+ :param client_type:
+ :type client_type: ClientTypeEnum
+ :param include_claims_in_id_token:
+ :type include_claims_in_id_token: bool
+ :param issuer_mode:
+ :type issuer_mode: IssuerModeEnum
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param refresh_token_validity:
+ :type refresh_token_validity: str
+ :param search: A search term.
+ :type search: str
+ :param signing_key:
+ :type signing_key: UUID
+ :param sub_mode:
+ :type sub_mode: SubModeEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_list_serialize(
+ access_code_validity=access_code_validity,
+ access_token_validity=access_token_validity,
+ application=application,
+ authorization_flow=authorization_flow,
+ client_id=client_id,
+ client_type=client_type,
+ include_claims_in_id_token=include_claims_in_id_token,
+ issuer_mode=issuer_mode,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ refresh_token_validity=refresh_token_validity,
+ search=search,
+ signing_key=signing_key,
+ sub_mode=sub_mode,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOAuth2ProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_list_with_http_info(
+ self,
+ access_code_validity: Optional[StrictStr] = None,
+ access_token_validity: Optional[StrictStr] = None,
+ application: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ client_id: Optional[StrictStr] = None,
+ client_type: Optional[Any] = None,
+ include_claims_in_id_token: Optional[StrictBool] = None,
+ issuer_mode: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ refresh_token_validity: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ signing_key: Optional[UUID] = None,
+ sub_mode: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedOAuth2ProviderList]:
+ """providers_oauth2_list
+
+ OAuth2Provider Viewset
+
+ :param access_code_validity:
+ :type access_code_validity: str
+ :param access_token_validity:
+ :type access_token_validity: str
+ :param application:
+ :type application: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param client_id:
+ :type client_id: str
+ :param client_type:
+ :type client_type: ClientTypeEnum
+ :param include_claims_in_id_token:
+ :type include_claims_in_id_token: bool
+ :param issuer_mode:
+ :type issuer_mode: IssuerModeEnum
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param refresh_token_validity:
+ :type refresh_token_validity: str
+ :param search: A search term.
+ :type search: str
+ :param signing_key:
+ :type signing_key: UUID
+ :param sub_mode:
+ :type sub_mode: SubModeEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_list_serialize(
+ access_code_validity=access_code_validity,
+ access_token_validity=access_token_validity,
+ application=application,
+ authorization_flow=authorization_flow,
+ client_id=client_id,
+ client_type=client_type,
+ include_claims_in_id_token=include_claims_in_id_token,
+ issuer_mode=issuer_mode,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ refresh_token_validity=refresh_token_validity,
+ search=search,
+ signing_key=signing_key,
+ sub_mode=sub_mode,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOAuth2ProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_list_without_preload_content(
+ self,
+ access_code_validity: Optional[StrictStr] = None,
+ access_token_validity: Optional[StrictStr] = None,
+ application: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ client_id: Optional[StrictStr] = None,
+ client_type: Optional[Any] = None,
+ include_claims_in_id_token: Optional[StrictBool] = None,
+ issuer_mode: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ refresh_token_validity: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ signing_key: Optional[UUID] = None,
+ sub_mode: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_list
+
+ OAuth2Provider Viewset
+
+ :param access_code_validity:
+ :type access_code_validity: str
+ :param access_token_validity:
+ :type access_token_validity: str
+ :param application:
+ :type application: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param client_id:
+ :type client_id: str
+ :param client_type:
+ :type client_type: ClientTypeEnum
+ :param include_claims_in_id_token:
+ :type include_claims_in_id_token: bool
+ :param issuer_mode:
+ :type issuer_mode: IssuerModeEnum
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param refresh_token_validity:
+ :type refresh_token_validity: str
+ :param search: A search term.
+ :type search: str
+ :param signing_key:
+ :type signing_key: UUID
+ :param sub_mode:
+ :type sub_mode: SubModeEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_list_serialize(
+ access_code_validity=access_code_validity,
+ access_token_validity=access_token_validity,
+ application=application,
+ authorization_flow=authorization_flow,
+ client_id=client_id,
+ client_type=client_type,
+ include_claims_in_id_token=include_claims_in_id_token,
+ issuer_mode=issuer_mode,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ refresh_token_validity=refresh_token_validity,
+ search=search,
+ signing_key=signing_key,
+ sub_mode=sub_mode,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedOAuth2ProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_list_serialize(
+ self,
+ access_code_validity,
+ access_token_validity,
+ application,
+ authorization_flow,
+ client_id,
+ client_type,
+ include_claims_in_id_token,
+ issuer_mode,
+ name,
+ ordering,
+ page,
+ page_size,
+ property_mappings,
+ refresh_token_validity,
+ search,
+ signing_key,
+ sub_mode,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'property_mappings': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if access_code_validity is not None:
+
+ _query_params.append(('access_code_validity', access_code_validity))
+
+ if access_token_validity is not None:
+
+ _query_params.append(('access_token_validity', access_token_validity))
+
+ if application is not None:
+
+ _query_params.append(('application', application))
+
+ if authorization_flow is not None:
+
+ _query_params.append(('authorization_flow', authorization_flow))
+
+ if client_id is not None:
+
+ _query_params.append(('client_id', client_id))
+
+ if client_type is not None:
+
+ _query_params.append(('client_type', client_type.value))
+
+ if include_claims_in_id_token is not None:
+
+ _query_params.append(('include_claims_in_id_token', include_claims_in_id_token))
+
+ if issuer_mode is not None:
+
+ _query_params.append(('issuer_mode', issuer_mode.value))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if property_mappings is not None:
+
+ _query_params.append(('property_mappings', property_mappings))
+
+ if refresh_token_validity is not None:
+
+ _query_params.append(('refresh_token_validity', refresh_token_validity))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if signing_key is not None:
+
+ _query_params.append(('signing_key', signing_key))
+
+ if sub_mode is not None:
+
+ _query_params.append(('sub_mode', sub_mode.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/oauth2/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ patched_o_auth2_provider_request: Optional[PatchedOAuth2ProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuth2Provider:
+ """providers_oauth2_partial_update
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param patched_o_auth2_provider_request:
+ :type patched_o_auth2_provider_request: PatchedOAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_partial_update_serialize(
+ id=id,
+ patched_o_auth2_provider_request=patched_o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ patched_o_auth2_provider_request: Optional[PatchedOAuth2ProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuth2Provider]:
+ """providers_oauth2_partial_update
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param patched_o_auth2_provider_request:
+ :type patched_o_auth2_provider_request: PatchedOAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_partial_update_serialize(
+ id=id,
+ patched_o_auth2_provider_request=patched_o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ patched_o_auth2_provider_request: Optional[PatchedOAuth2ProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_partial_update
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param patched_o_auth2_provider_request:
+ :type patched_o_auth2_provider_request: PatchedOAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_partial_update_serialize(
+ id=id,
+ patched_o_auth2_provider_request=patched_o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_partial_update_serialize(
+ self,
+ id,
+ patched_o_auth2_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_o_auth2_provider_request is not None:
+ _body_params = patched_o_auth2_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/oauth2/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_preview_user_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PropertyMappingPreview:
+ """providers_oauth2_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_preview_user_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PropertyMappingPreview]:
+ """providers_oauth2_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_preview_user_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_preview_user_retrieve_serialize(
+ self,
+ id,
+ for_user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if for_user is not None:
+
+ _query_params.append(('for_user', for_user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/oauth2/{id}/preview_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuth2Provider:
+ """providers_oauth2_retrieve
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuth2Provider]:
+ """providers_oauth2_retrieve
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_retrieve
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/oauth2/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_setup_urls_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuth2ProviderSetupURLs:
+ """providers_oauth2_setup_urls_retrieve
+
+ Get Providers setup URLs
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_setup_urls_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2ProviderSetupURLs",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_setup_urls_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuth2ProviderSetupURLs]:
+ """providers_oauth2_setup_urls_retrieve
+
+ Get Providers setup URLs
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_setup_urls_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2ProviderSetupURLs",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_setup_urls_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_setup_urls_retrieve
+
+ Get Providers setup URLs
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_setup_urls_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2ProviderSetupURLs",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_setup_urls_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/oauth2/{id}/setup_urls/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ o_auth2_provider_request: OAuth2ProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> OAuth2Provider:
+ """providers_oauth2_update
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param o_auth2_provider_request: (required)
+ :type o_auth2_provider_request: OAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_update_serialize(
+ id=id,
+ o_auth2_provider_request=o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ o_auth2_provider_request: OAuth2ProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[OAuth2Provider]:
+ """providers_oauth2_update
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param o_auth2_provider_request: (required)
+ :type o_auth2_provider_request: OAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_update_serialize(
+ id=id,
+ o_auth2_provider_request=o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ o_auth2_provider_request: OAuth2ProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_update
+
+ OAuth2Provider Viewset
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param o_auth2_provider_request: (required)
+ :type o_auth2_provider_request: OAuth2ProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_update_serialize(
+ id=id,
+ o_auth2_provider_request=o_auth2_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "OAuth2Provider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_update_serialize(
+ self,
+ id,
+ o_auth2_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if o_auth2_provider_request is not None:
+ _body_params = o_auth2_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/oauth2/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_oauth2_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_oauth2_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_oauth2_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_oauth2_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_oauth2_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this OAuth2/OpenID Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_oauth2_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this OAuth2/OpenID Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_oauth2_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_oauth2_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/oauth2/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_create(
+ self,
+ proxy_provider_request: ProxyProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ProxyProvider:
+ """providers_proxy_create
+
+ ProxyProvider Viewset
+
+ :param proxy_provider_request: (required)
+ :type proxy_provider_request: ProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_create_serialize(
+ proxy_provider_request=proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_create_with_http_info(
+ self,
+ proxy_provider_request: ProxyProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ProxyProvider]:
+ """providers_proxy_create
+
+ ProxyProvider Viewset
+
+ :param proxy_provider_request: (required)
+ :type proxy_provider_request: ProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_create_serialize(
+ proxy_provider_request=proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_create_without_preload_content(
+ self,
+ proxy_provider_request: ProxyProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_create
+
+ ProxyProvider Viewset
+
+ :param proxy_provider_request: (required)
+ :type proxy_provider_request: ProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_create_serialize(
+ proxy_provider_request=proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_create_serialize(
+ self,
+ proxy_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if proxy_provider_request is not None:
+ _body_params = proxy_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/proxy/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_proxy_destroy
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_proxy_destroy
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_destroy
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/proxy/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_list(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ basic_auth_enabled__iexact: Optional[StrictBool] = None,
+ basic_auth_password_attribute__iexact: Optional[StrictStr] = None,
+ basic_auth_user_attribute__iexact: Optional[StrictStr] = None,
+ certificate__kp_uuid__iexact: Optional[UUID] = None,
+ certificate__name__iexact: Optional[StrictStr] = None,
+ cookie_domain__iexact: Optional[StrictStr] = None,
+ external_host__iexact: Optional[StrictStr] = None,
+ internal_host__iexact: Optional[StrictStr] = None,
+ internal_host_ssl_validation__iexact: Optional[StrictBool] = None,
+ mode__iexact: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings__iexact: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ skip_path_regex__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedProxyProviderList:
+ """providers_proxy_list
+
+ ProxyProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param basic_auth_enabled__iexact:
+ :type basic_auth_enabled__iexact: bool
+ :param basic_auth_password_attribute__iexact:
+ :type basic_auth_password_attribute__iexact: str
+ :param basic_auth_user_attribute__iexact:
+ :type basic_auth_user_attribute__iexact: str
+ :param certificate__kp_uuid__iexact:
+ :type certificate__kp_uuid__iexact: UUID
+ :param certificate__name__iexact:
+ :type certificate__name__iexact: str
+ :param cookie_domain__iexact:
+ :type cookie_domain__iexact: str
+ :param external_host__iexact:
+ :type external_host__iexact: str
+ :param internal_host__iexact:
+ :type internal_host__iexact: str
+ :param internal_host_ssl_validation__iexact:
+ :type internal_host_ssl_validation__iexact: bool
+ :param mode__iexact:
+ :type mode__iexact: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings__iexact:
+ :type property_mappings__iexact: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param skip_path_regex__iexact:
+ :type skip_path_regex__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ basic_auth_enabled__iexact=basic_auth_enabled__iexact,
+ basic_auth_password_attribute__iexact=basic_auth_password_attribute__iexact,
+ basic_auth_user_attribute__iexact=basic_auth_user_attribute__iexact,
+ certificate__kp_uuid__iexact=certificate__kp_uuid__iexact,
+ certificate__name__iexact=certificate__name__iexact,
+ cookie_domain__iexact=cookie_domain__iexact,
+ external_host__iexact=external_host__iexact,
+ internal_host__iexact=internal_host__iexact,
+ internal_host_ssl_validation__iexact=internal_host_ssl_validation__iexact,
+ mode__iexact=mode__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings__iexact=property_mappings__iexact,
+ search=search,
+ skip_path_regex__iexact=skip_path_regex__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProxyProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_list_with_http_info(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ basic_auth_enabled__iexact: Optional[StrictBool] = None,
+ basic_auth_password_attribute__iexact: Optional[StrictStr] = None,
+ basic_auth_user_attribute__iexact: Optional[StrictStr] = None,
+ certificate__kp_uuid__iexact: Optional[UUID] = None,
+ certificate__name__iexact: Optional[StrictStr] = None,
+ cookie_domain__iexact: Optional[StrictStr] = None,
+ external_host__iexact: Optional[StrictStr] = None,
+ internal_host__iexact: Optional[StrictStr] = None,
+ internal_host_ssl_validation__iexact: Optional[StrictBool] = None,
+ mode__iexact: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings__iexact: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ skip_path_regex__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedProxyProviderList]:
+ """providers_proxy_list
+
+ ProxyProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param basic_auth_enabled__iexact:
+ :type basic_auth_enabled__iexact: bool
+ :param basic_auth_password_attribute__iexact:
+ :type basic_auth_password_attribute__iexact: str
+ :param basic_auth_user_attribute__iexact:
+ :type basic_auth_user_attribute__iexact: str
+ :param certificate__kp_uuid__iexact:
+ :type certificate__kp_uuid__iexact: UUID
+ :param certificate__name__iexact:
+ :type certificate__name__iexact: str
+ :param cookie_domain__iexact:
+ :type cookie_domain__iexact: str
+ :param external_host__iexact:
+ :type external_host__iexact: str
+ :param internal_host__iexact:
+ :type internal_host__iexact: str
+ :param internal_host_ssl_validation__iexact:
+ :type internal_host_ssl_validation__iexact: bool
+ :param mode__iexact:
+ :type mode__iexact: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings__iexact:
+ :type property_mappings__iexact: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param skip_path_regex__iexact:
+ :type skip_path_regex__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ basic_auth_enabled__iexact=basic_auth_enabled__iexact,
+ basic_auth_password_attribute__iexact=basic_auth_password_attribute__iexact,
+ basic_auth_user_attribute__iexact=basic_auth_user_attribute__iexact,
+ certificate__kp_uuid__iexact=certificate__kp_uuid__iexact,
+ certificate__name__iexact=certificate__name__iexact,
+ cookie_domain__iexact=cookie_domain__iexact,
+ external_host__iexact=external_host__iexact,
+ internal_host__iexact=internal_host__iexact,
+ internal_host_ssl_validation__iexact=internal_host_ssl_validation__iexact,
+ mode__iexact=mode__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings__iexact=property_mappings__iexact,
+ search=search,
+ skip_path_regex__iexact=skip_path_regex__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProxyProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_list_without_preload_content(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ basic_auth_enabled__iexact: Optional[StrictBool] = None,
+ basic_auth_password_attribute__iexact: Optional[StrictStr] = None,
+ basic_auth_user_attribute__iexact: Optional[StrictStr] = None,
+ certificate__kp_uuid__iexact: Optional[UUID] = None,
+ certificate__name__iexact: Optional[StrictStr] = None,
+ cookie_domain__iexact: Optional[StrictStr] = None,
+ external_host__iexact: Optional[StrictStr] = None,
+ internal_host__iexact: Optional[StrictStr] = None,
+ internal_host_ssl_validation__iexact: Optional[StrictBool] = None,
+ mode__iexact: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings__iexact: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ skip_path_regex__iexact: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_list
+
+ ProxyProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param basic_auth_enabled__iexact:
+ :type basic_auth_enabled__iexact: bool
+ :param basic_auth_password_attribute__iexact:
+ :type basic_auth_password_attribute__iexact: str
+ :param basic_auth_user_attribute__iexact:
+ :type basic_auth_user_attribute__iexact: str
+ :param certificate__kp_uuid__iexact:
+ :type certificate__kp_uuid__iexact: UUID
+ :param certificate__name__iexact:
+ :type certificate__name__iexact: str
+ :param cookie_domain__iexact:
+ :type cookie_domain__iexact: str
+ :param external_host__iexact:
+ :type external_host__iexact: str
+ :param internal_host__iexact:
+ :type internal_host__iexact: str
+ :param internal_host_ssl_validation__iexact:
+ :type internal_host_ssl_validation__iexact: bool
+ :param mode__iexact:
+ :type mode__iexact: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings__iexact:
+ :type property_mappings__iexact: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param skip_path_regex__iexact:
+ :type skip_path_regex__iexact: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ basic_auth_enabled__iexact=basic_auth_enabled__iexact,
+ basic_auth_password_attribute__iexact=basic_auth_password_attribute__iexact,
+ basic_auth_user_attribute__iexact=basic_auth_user_attribute__iexact,
+ certificate__kp_uuid__iexact=certificate__kp_uuid__iexact,
+ certificate__name__iexact=certificate__name__iexact,
+ cookie_domain__iexact=cookie_domain__iexact,
+ external_host__iexact=external_host__iexact,
+ internal_host__iexact=internal_host__iexact,
+ internal_host_ssl_validation__iexact=internal_host_ssl_validation__iexact,
+ mode__iexact=mode__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings__iexact=property_mappings__iexact,
+ search=search,
+ skip_path_regex__iexact=skip_path_regex__iexact,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedProxyProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_list_serialize(
+ self,
+ application__isnull,
+ authorization_flow__slug__iexact,
+ basic_auth_enabled__iexact,
+ basic_auth_password_attribute__iexact,
+ basic_auth_user_attribute__iexact,
+ certificate__kp_uuid__iexact,
+ certificate__name__iexact,
+ cookie_domain__iexact,
+ external_host__iexact,
+ internal_host__iexact,
+ internal_host_ssl_validation__iexact,
+ mode__iexact,
+ name__iexact,
+ ordering,
+ page,
+ page_size,
+ property_mappings__iexact,
+ search,
+ skip_path_regex__iexact,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'property_mappings__iexact': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application__isnull is not None:
+
+ _query_params.append(('application__isnull', application__isnull))
+
+ if authorization_flow__slug__iexact is not None:
+
+ _query_params.append(('authorization_flow__slug__iexact', authorization_flow__slug__iexact))
+
+ if basic_auth_enabled__iexact is not None:
+
+ _query_params.append(('basic_auth_enabled__iexact', basic_auth_enabled__iexact))
+
+ if basic_auth_password_attribute__iexact is not None:
+
+ _query_params.append(('basic_auth_password_attribute__iexact', basic_auth_password_attribute__iexact))
+
+ if basic_auth_user_attribute__iexact is not None:
+
+ _query_params.append(('basic_auth_user_attribute__iexact', basic_auth_user_attribute__iexact))
+
+ if certificate__kp_uuid__iexact is not None:
+
+ _query_params.append(('certificate__kp_uuid__iexact', certificate__kp_uuid__iexact))
+
+ if certificate__name__iexact is not None:
+
+ _query_params.append(('certificate__name__iexact', certificate__name__iexact))
+
+ if cookie_domain__iexact is not None:
+
+ _query_params.append(('cookie_domain__iexact', cookie_domain__iexact))
+
+ if external_host__iexact is not None:
+
+ _query_params.append(('external_host__iexact', external_host__iexact))
+
+ if internal_host__iexact is not None:
+
+ _query_params.append(('internal_host__iexact', internal_host__iexact))
+
+ if internal_host_ssl_validation__iexact is not None:
+
+ _query_params.append(('internal_host_ssl_validation__iexact', internal_host_ssl_validation__iexact))
+
+ if mode__iexact is not None:
+
+ _query_params.append(('mode__iexact', mode__iexact))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if property_mappings__iexact is not None:
+
+ _query_params.append(('property_mappings__iexact', property_mappings__iexact))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if skip_path_regex__iexact is not None:
+
+ _query_params.append(('skip_path_regex__iexact', skip_path_regex__iexact))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/proxy/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ patched_proxy_provider_request: Optional[PatchedProxyProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ProxyProvider:
+ """providers_proxy_partial_update
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param patched_proxy_provider_request:
+ :type patched_proxy_provider_request: PatchedProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_partial_update_serialize(
+ id=id,
+ patched_proxy_provider_request=patched_proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ patched_proxy_provider_request: Optional[PatchedProxyProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ProxyProvider]:
+ """providers_proxy_partial_update
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param patched_proxy_provider_request:
+ :type patched_proxy_provider_request: PatchedProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_partial_update_serialize(
+ id=id,
+ patched_proxy_provider_request=patched_proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ patched_proxy_provider_request: Optional[PatchedProxyProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_partial_update
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param patched_proxy_provider_request:
+ :type patched_proxy_provider_request: PatchedProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_partial_update_serialize(
+ id=id,
+ patched_proxy_provider_request=patched_proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_partial_update_serialize(
+ self,
+ id,
+ patched_proxy_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_proxy_provider_request is not None:
+ _body_params = patched_proxy_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/proxy/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ProxyProvider:
+ """providers_proxy_retrieve
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ProxyProvider]:
+ """providers_proxy_retrieve
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_retrieve
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/proxy/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ proxy_provider_request: ProxyProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ProxyProvider:
+ """providers_proxy_update
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param proxy_provider_request: (required)
+ :type proxy_provider_request: ProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_update_serialize(
+ id=id,
+ proxy_provider_request=proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ proxy_provider_request: ProxyProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ProxyProvider]:
+ """providers_proxy_update
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param proxy_provider_request: (required)
+ :type proxy_provider_request: ProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_update_serialize(
+ id=id,
+ proxy_provider_request=proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ proxy_provider_request: ProxyProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_update
+
+ ProxyProvider Viewset
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param proxy_provider_request: (required)
+ :type proxy_provider_request: ProxyProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_update_serialize(
+ id=id,
+ proxy_provider_request=proxy_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ProxyProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_update_serialize(
+ self,
+ id,
+ proxy_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if proxy_provider_request is not None:
+ _body_params = proxy_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/proxy/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_proxy_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_proxy_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_proxy_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_proxy_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_proxy_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Proxy Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_proxy_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Proxy Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_proxy_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_proxy_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/proxy/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_create(
+ self,
+ rac_provider_request: RACProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACProvider:
+ """providers_rac_create
+
+ RACProvider Viewset
+
+ :param rac_provider_request: (required)
+ :type rac_provider_request: RACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_create_serialize(
+ rac_provider_request=rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_create_with_http_info(
+ self,
+ rac_provider_request: RACProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACProvider]:
+ """providers_rac_create
+
+ RACProvider Viewset
+
+ :param rac_provider_request: (required)
+ :type rac_provider_request: RACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_create_serialize(
+ rac_provider_request=rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_create_without_preload_content(
+ self,
+ rac_provider_request: RACProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_create
+
+ RACProvider Viewset
+
+ :param rac_provider_request: (required)
+ :type rac_provider_request: RACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_create_serialize(
+ rac_provider_request=rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_create_serialize(
+ self,
+ rac_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if rac_provider_request is not None:
+ _body_params = rac_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/rac/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_rac_destroy
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_rac_destroy
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_destroy
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/rac/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_list(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRACProviderList:
+ """providers_rac_list
+
+ RACProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_list_serialize(
+ application__isnull=application__isnull,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRACProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_list_with_http_info(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRACProviderList]:
+ """providers_rac_list
+
+ RACProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_list_serialize(
+ application__isnull=application__isnull,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRACProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_list_without_preload_content(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_list
+
+ RACProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_list_serialize(
+ application__isnull=application__isnull,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRACProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_list_serialize(
+ self,
+ application__isnull,
+ name__iexact,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application__isnull is not None:
+
+ _query_params.append(('application__isnull', application__isnull))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/rac/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ patched_rac_provider_request: Optional[PatchedRACProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACProvider:
+ """providers_rac_partial_update
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param patched_rac_provider_request:
+ :type patched_rac_provider_request: PatchedRACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_partial_update_serialize(
+ id=id,
+ patched_rac_provider_request=patched_rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ patched_rac_provider_request: Optional[PatchedRACProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACProvider]:
+ """providers_rac_partial_update
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param patched_rac_provider_request:
+ :type patched_rac_provider_request: PatchedRACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_partial_update_serialize(
+ id=id,
+ patched_rac_provider_request=patched_rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ patched_rac_provider_request: Optional[PatchedRACProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_partial_update
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param patched_rac_provider_request:
+ :type patched_rac_provider_request: PatchedRACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_partial_update_serialize(
+ id=id,
+ patched_rac_provider_request=patched_rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_partial_update_serialize(
+ self,
+ id,
+ patched_rac_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_rac_provider_request is not None:
+ _body_params = patched_rac_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/rac/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACProvider:
+ """providers_rac_retrieve
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACProvider]:
+ """providers_rac_retrieve
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_retrieve
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/rac/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ rac_provider_request: RACProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RACProvider:
+ """providers_rac_update
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param rac_provider_request: (required)
+ :type rac_provider_request: RACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_update_serialize(
+ id=id,
+ rac_provider_request=rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ rac_provider_request: RACProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RACProvider]:
+ """providers_rac_update
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param rac_provider_request: (required)
+ :type rac_provider_request: RACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_update_serialize(
+ id=id,
+ rac_provider_request=rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ rac_provider_request: RACProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_update
+
+ RACProvider Viewset
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param rac_provider_request: (required)
+ :type rac_provider_request: RACProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_update_serialize(
+ id=id,
+ rac_provider_request=rac_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RACProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_update_serialize(
+ self,
+ id,
+ rac_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if rac_provider_request is not None:
+ _body_params = rac_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/rac/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_rac_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_rac_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_rac_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_rac_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_rac_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this RAC Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_rac_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this RAC Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_rac_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_rac_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/rac/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_create(
+ self,
+ radius_provider_request: RadiusProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProvider:
+ """providers_radius_create
+
+ RadiusProvider Viewset
+
+ :param radius_provider_request: (required)
+ :type radius_provider_request: RadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_create_serialize(
+ radius_provider_request=radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_create_with_http_info(
+ self,
+ radius_provider_request: RadiusProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProvider]:
+ """providers_radius_create
+
+ RadiusProvider Viewset
+
+ :param radius_provider_request: (required)
+ :type radius_provider_request: RadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_create_serialize(
+ radius_provider_request=radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_create_without_preload_content(
+ self,
+ radius_provider_request: RadiusProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_create
+
+ RadiusProvider Viewset
+
+ :param radius_provider_request: (required)
+ :type radius_provider_request: RadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_create_serialize(
+ radius_provider_request=radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_create_serialize(
+ self,
+ radius_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if radius_provider_request is not None:
+ _body_params = radius_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/radius/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_radius_destroy
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_radius_destroy
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_destroy
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/radius/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_list(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ client_networks__iexact: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRadiusProviderList:
+ """providers_radius_list
+
+ RadiusProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param client_networks__iexact:
+ :type client_networks__iexact: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ client_networks__iexact=client_networks__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_list_with_http_info(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ client_networks__iexact: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRadiusProviderList]:
+ """providers_radius_list
+
+ RadiusProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param client_networks__iexact:
+ :type client_networks__iexact: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ client_networks__iexact=client_networks__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_list_without_preload_content(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ authorization_flow__slug__iexact: Optional[StrictStr] = None,
+ client_networks__iexact: Optional[StrictStr] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_list
+
+ RadiusProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param authorization_flow__slug__iexact:
+ :type authorization_flow__slug__iexact: str
+ :param client_networks__iexact:
+ :type client_networks__iexact: str
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_list_serialize(
+ application__isnull=application__isnull,
+ authorization_flow__slug__iexact=authorization_flow__slug__iexact,
+ client_networks__iexact=client_networks__iexact,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRadiusProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_list_serialize(
+ self,
+ application__isnull,
+ authorization_flow__slug__iexact,
+ client_networks__iexact,
+ name__iexact,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application__isnull is not None:
+
+ _query_params.append(('application__isnull', application__isnull))
+
+ if authorization_flow__slug__iexact is not None:
+
+ _query_params.append(('authorization_flow__slug__iexact', authorization_flow__slug__iexact))
+
+ if client_networks__iexact is not None:
+
+ _query_params.append(('client_networks__iexact', client_networks__iexact))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/radius/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ patched_radius_provider_request: Optional[PatchedRadiusProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProvider:
+ """providers_radius_partial_update
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param patched_radius_provider_request:
+ :type patched_radius_provider_request: PatchedRadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_partial_update_serialize(
+ id=id,
+ patched_radius_provider_request=patched_radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ patched_radius_provider_request: Optional[PatchedRadiusProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProvider]:
+ """providers_radius_partial_update
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param patched_radius_provider_request:
+ :type patched_radius_provider_request: PatchedRadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_partial_update_serialize(
+ id=id,
+ patched_radius_provider_request=patched_radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ patched_radius_provider_request: Optional[PatchedRadiusProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_partial_update
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param patched_radius_provider_request:
+ :type patched_radius_provider_request: PatchedRadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_partial_update_serialize(
+ id=id,
+ patched_radius_provider_request=patched_radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_partial_update_serialize(
+ self,
+ id,
+ patched_radius_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_radius_provider_request is not None:
+ _body_params = patched_radius_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/radius/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProvider:
+ """providers_radius_retrieve
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProvider]:
+ """providers_radius_retrieve
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_retrieve
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/radius/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ radius_provider_request: RadiusProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RadiusProvider:
+ """providers_radius_update
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param radius_provider_request: (required)
+ :type radius_provider_request: RadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_update_serialize(
+ id=id,
+ radius_provider_request=radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ radius_provider_request: RadiusProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[RadiusProvider]:
+ """providers_radius_update
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param radius_provider_request: (required)
+ :type radius_provider_request: RadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_update_serialize(
+ id=id,
+ radius_provider_request=radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ radius_provider_request: RadiusProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_update
+
+ RadiusProvider Viewset
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param radius_provider_request: (required)
+ :type radius_provider_request: RadiusProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_update_serialize(
+ id=id,
+ radius_provider_request=radius_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "RadiusProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_update_serialize(
+ self,
+ id,
+ radius_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if radius_provider_request is not None:
+ _body_params = radius_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/radius/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_radius_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_radius_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_radius_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_radius_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_radius_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Radius Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_radius_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Radius Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_radius_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_radius_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/radius/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_create(
+ self,
+ saml_provider_request: SAMLProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLProvider:
+ """providers_saml_create
+
+ SAMLProvider Viewset
+
+ :param saml_provider_request: (required)
+ :type saml_provider_request: SAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_create_serialize(
+ saml_provider_request=saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_create_with_http_info(
+ self,
+ saml_provider_request: SAMLProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLProvider]:
+ """providers_saml_create
+
+ SAMLProvider Viewset
+
+ :param saml_provider_request: (required)
+ :type saml_provider_request: SAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_create_serialize(
+ saml_provider_request=saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_create_without_preload_content(
+ self,
+ saml_provider_request: SAMLProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_create
+
+ SAMLProvider Viewset
+
+ :param saml_provider_request: (required)
+ :type saml_provider_request: SAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_create_serialize(
+ saml_provider_request=saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_create_serialize(
+ self,
+ saml_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if saml_provider_request is not None:
+ _body_params = saml_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/saml/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_saml_destroy
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_saml_destroy
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_destroy
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/saml/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_import_metadata_create(
+ self,
+ name: Annotated[str, Field(min_length=1, strict=True)],
+ authorization_flow: UUID,
+ invalidation_flow: UUID,
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLProvider:
+ """providers_saml_import_metadata_create
+
+ Create provider from SAML Metadata
+
+ :param name: (required)
+ :type name: str
+ :param authorization_flow: (required)
+ :type authorization_flow: UUID
+ :param invalidation_flow: (required)
+ :type invalidation_flow: UUID
+ :param file: (required)
+ :type file: bytes
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_import_metadata_create_serialize(
+ name=name,
+ authorization_flow=authorization_flow,
+ invalidation_flow=invalidation_flow,
+ file=file,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLProvider",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_import_metadata_create_with_http_info(
+ self,
+ name: Annotated[str, Field(min_length=1, strict=True)],
+ authorization_flow: UUID,
+ invalidation_flow: UUID,
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLProvider]:
+ """providers_saml_import_metadata_create
+
+ Create provider from SAML Metadata
+
+ :param name: (required)
+ :type name: str
+ :param authorization_flow: (required)
+ :type authorization_flow: UUID
+ :param invalidation_flow: (required)
+ :type invalidation_flow: UUID
+ :param file: (required)
+ :type file: bytes
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_import_metadata_create_serialize(
+ name=name,
+ authorization_flow=authorization_flow,
+ invalidation_flow=invalidation_flow,
+ file=file,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLProvider",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_import_metadata_create_without_preload_content(
+ self,
+ name: Annotated[str, Field(min_length=1, strict=True)],
+ authorization_flow: UUID,
+ invalidation_flow: UUID,
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_import_metadata_create
+
+ Create provider from SAML Metadata
+
+ :param name: (required)
+ :type name: str
+ :param authorization_flow: (required)
+ :type authorization_flow: UUID
+ :param invalidation_flow: (required)
+ :type invalidation_flow: UUID
+ :param file: (required)
+ :type file: bytes
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_import_metadata_create_serialize(
+ name=name,
+ authorization_flow=authorization_flow,
+ invalidation_flow=invalidation_flow,
+ file=file,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SAMLProvider",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_import_metadata_create_serialize(
+ self,
+ name,
+ authorization_flow,
+ invalidation_flow,
+ file,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ if name is not None:
+ _form_params.append(('name', name))
+ if authorization_flow is not None:
+ _form_params.append(('authorization_flow', authorization_flow))
+ if invalidation_flow is not None:
+ _form_params.append(('invalidation_flow', invalidation_flow))
+ if file is not None:
+ _files['file'] = file
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'multipart/form-data'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/saml/import_metadata/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_list(
+ self,
+ acs_url: Optional[StrictStr] = None,
+ assertion_valid_not_before: Optional[StrictStr] = None,
+ assertion_valid_not_on_or_after: Optional[StrictStr] = None,
+ audience: Optional[StrictStr] = None,
+ authentication_flow: Optional[UUID] = None,
+ authn_context_class_ref_mapping: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ backchannel_application: Optional[UUID] = None,
+ default_name_id_policy: Optional[SAMLNameIDPolicyEnum] = None,
+ default_relay_state: Optional[StrictStr] = None,
+ digest_algorithm: Optional[DigestAlgorithmEnum] = None,
+ encryption_kp: Optional[UUID] = None,
+ invalidation_flow: Optional[UUID] = None,
+ is_backchannel: Optional[StrictBool] = None,
+ issuer_override: Optional[StrictStr] = None,
+ logout_method: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ name_id_mapping: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session_valid_not_on_or_after: Optional[StrictStr] = None,
+ sign_assertion: Optional[StrictBool] = None,
+ sign_logout_request: Optional[StrictBool] = None,
+ sign_logout_response: Optional[StrictBool] = None,
+ sign_response: Optional[StrictBool] = None,
+ signature_algorithm: Optional[SignatureAlgorithmEnum] = None,
+ signing_kp: Optional[UUID] = None,
+ sls_binding: Optional[Any] = None,
+ sls_url: Optional[StrictStr] = None,
+ sp_binding: Optional[Any] = None,
+ verification_kp: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSAMLProviderList:
+ """providers_saml_list
+
+ SAMLProvider Viewset
+
+ :param acs_url:
+ :type acs_url: str
+ :param assertion_valid_not_before:
+ :type assertion_valid_not_before: str
+ :param assertion_valid_not_on_or_after:
+ :type assertion_valid_not_on_or_after: str
+ :param audience:
+ :type audience: str
+ :param authentication_flow:
+ :type authentication_flow: UUID
+ :param authn_context_class_ref_mapping:
+ :type authn_context_class_ref_mapping: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param backchannel_application:
+ :type backchannel_application: UUID
+ :param default_name_id_policy:
+ :type default_name_id_policy: SAMLNameIDPolicyEnum
+ :param default_relay_state:
+ :type default_relay_state: str
+ :param digest_algorithm:
+ :type digest_algorithm: DigestAlgorithmEnum
+ :param encryption_kp:
+ :type encryption_kp: UUID
+ :param invalidation_flow:
+ :type invalidation_flow: UUID
+ :param is_backchannel:
+ :type is_backchannel: bool
+ :param issuer_override:
+ :type issuer_override: str
+ :param logout_method:
+ :type logout_method: SAMLLogoutMethods
+ :param name:
+ :type name: str
+ :param name_id_mapping:
+ :type name_id_mapping: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param session_valid_not_on_or_after:
+ :type session_valid_not_on_or_after: str
+ :param sign_assertion:
+ :type sign_assertion: bool
+ :param sign_logout_request:
+ :type sign_logout_request: bool
+ :param sign_logout_response:
+ :type sign_logout_response: bool
+ :param sign_response:
+ :type sign_response: bool
+ :param signature_algorithm:
+ :type signature_algorithm: SignatureAlgorithmEnum
+ :param signing_kp:
+ :type signing_kp: UUID
+ :param sls_binding:
+ :type sls_binding: SAMLBindingsEnum
+ :param sls_url:
+ :type sls_url: str
+ :param sp_binding:
+ :type sp_binding: SAMLBindingsEnum
+ :param verification_kp:
+ :type verification_kp: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_list_serialize(
+ acs_url=acs_url,
+ assertion_valid_not_before=assertion_valid_not_before,
+ assertion_valid_not_on_or_after=assertion_valid_not_on_or_after,
+ audience=audience,
+ authentication_flow=authentication_flow,
+ authn_context_class_ref_mapping=authn_context_class_ref_mapping,
+ authorization_flow=authorization_flow,
+ backchannel_application=backchannel_application,
+ default_name_id_policy=default_name_id_policy,
+ default_relay_state=default_relay_state,
+ digest_algorithm=digest_algorithm,
+ encryption_kp=encryption_kp,
+ invalidation_flow=invalidation_flow,
+ is_backchannel=is_backchannel,
+ issuer_override=issuer_override,
+ logout_method=logout_method,
+ name=name,
+ name_id_mapping=name_id_mapping,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ search=search,
+ session_valid_not_on_or_after=session_valid_not_on_or_after,
+ sign_assertion=sign_assertion,
+ sign_logout_request=sign_logout_request,
+ sign_logout_response=sign_logout_response,
+ sign_response=sign_response,
+ signature_algorithm=signature_algorithm,
+ signing_kp=signing_kp,
+ sls_binding=sls_binding,
+ sls_url=sls_url,
+ sp_binding=sp_binding,
+ verification_kp=verification_kp,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_list_with_http_info(
+ self,
+ acs_url: Optional[StrictStr] = None,
+ assertion_valid_not_before: Optional[StrictStr] = None,
+ assertion_valid_not_on_or_after: Optional[StrictStr] = None,
+ audience: Optional[StrictStr] = None,
+ authentication_flow: Optional[UUID] = None,
+ authn_context_class_ref_mapping: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ backchannel_application: Optional[UUID] = None,
+ default_name_id_policy: Optional[SAMLNameIDPolicyEnum] = None,
+ default_relay_state: Optional[StrictStr] = None,
+ digest_algorithm: Optional[DigestAlgorithmEnum] = None,
+ encryption_kp: Optional[UUID] = None,
+ invalidation_flow: Optional[UUID] = None,
+ is_backchannel: Optional[StrictBool] = None,
+ issuer_override: Optional[StrictStr] = None,
+ logout_method: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ name_id_mapping: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session_valid_not_on_or_after: Optional[StrictStr] = None,
+ sign_assertion: Optional[StrictBool] = None,
+ sign_logout_request: Optional[StrictBool] = None,
+ sign_logout_response: Optional[StrictBool] = None,
+ sign_response: Optional[StrictBool] = None,
+ signature_algorithm: Optional[SignatureAlgorithmEnum] = None,
+ signing_kp: Optional[UUID] = None,
+ sls_binding: Optional[Any] = None,
+ sls_url: Optional[StrictStr] = None,
+ sp_binding: Optional[Any] = None,
+ verification_kp: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSAMLProviderList]:
+ """providers_saml_list
+
+ SAMLProvider Viewset
+
+ :param acs_url:
+ :type acs_url: str
+ :param assertion_valid_not_before:
+ :type assertion_valid_not_before: str
+ :param assertion_valid_not_on_or_after:
+ :type assertion_valid_not_on_or_after: str
+ :param audience:
+ :type audience: str
+ :param authentication_flow:
+ :type authentication_flow: UUID
+ :param authn_context_class_ref_mapping:
+ :type authn_context_class_ref_mapping: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param backchannel_application:
+ :type backchannel_application: UUID
+ :param default_name_id_policy:
+ :type default_name_id_policy: SAMLNameIDPolicyEnum
+ :param default_relay_state:
+ :type default_relay_state: str
+ :param digest_algorithm:
+ :type digest_algorithm: DigestAlgorithmEnum
+ :param encryption_kp:
+ :type encryption_kp: UUID
+ :param invalidation_flow:
+ :type invalidation_flow: UUID
+ :param is_backchannel:
+ :type is_backchannel: bool
+ :param issuer_override:
+ :type issuer_override: str
+ :param logout_method:
+ :type logout_method: SAMLLogoutMethods
+ :param name:
+ :type name: str
+ :param name_id_mapping:
+ :type name_id_mapping: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param session_valid_not_on_or_after:
+ :type session_valid_not_on_or_after: str
+ :param sign_assertion:
+ :type sign_assertion: bool
+ :param sign_logout_request:
+ :type sign_logout_request: bool
+ :param sign_logout_response:
+ :type sign_logout_response: bool
+ :param sign_response:
+ :type sign_response: bool
+ :param signature_algorithm:
+ :type signature_algorithm: SignatureAlgorithmEnum
+ :param signing_kp:
+ :type signing_kp: UUID
+ :param sls_binding:
+ :type sls_binding: SAMLBindingsEnum
+ :param sls_url:
+ :type sls_url: str
+ :param sp_binding:
+ :type sp_binding: SAMLBindingsEnum
+ :param verification_kp:
+ :type verification_kp: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_list_serialize(
+ acs_url=acs_url,
+ assertion_valid_not_before=assertion_valid_not_before,
+ assertion_valid_not_on_or_after=assertion_valid_not_on_or_after,
+ audience=audience,
+ authentication_flow=authentication_flow,
+ authn_context_class_ref_mapping=authn_context_class_ref_mapping,
+ authorization_flow=authorization_flow,
+ backchannel_application=backchannel_application,
+ default_name_id_policy=default_name_id_policy,
+ default_relay_state=default_relay_state,
+ digest_algorithm=digest_algorithm,
+ encryption_kp=encryption_kp,
+ invalidation_flow=invalidation_flow,
+ is_backchannel=is_backchannel,
+ issuer_override=issuer_override,
+ logout_method=logout_method,
+ name=name,
+ name_id_mapping=name_id_mapping,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ search=search,
+ session_valid_not_on_or_after=session_valid_not_on_or_after,
+ sign_assertion=sign_assertion,
+ sign_logout_request=sign_logout_request,
+ sign_logout_response=sign_logout_response,
+ sign_response=sign_response,
+ signature_algorithm=signature_algorithm,
+ signing_kp=signing_kp,
+ sls_binding=sls_binding,
+ sls_url=sls_url,
+ sp_binding=sp_binding,
+ verification_kp=verification_kp,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_list_without_preload_content(
+ self,
+ acs_url: Optional[StrictStr] = None,
+ assertion_valid_not_before: Optional[StrictStr] = None,
+ assertion_valid_not_on_or_after: Optional[StrictStr] = None,
+ audience: Optional[StrictStr] = None,
+ authentication_flow: Optional[UUID] = None,
+ authn_context_class_ref_mapping: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ backchannel_application: Optional[UUID] = None,
+ default_name_id_policy: Optional[SAMLNameIDPolicyEnum] = None,
+ default_relay_state: Optional[StrictStr] = None,
+ digest_algorithm: Optional[DigestAlgorithmEnum] = None,
+ encryption_kp: Optional[UUID] = None,
+ invalidation_flow: Optional[UUID] = None,
+ is_backchannel: Optional[StrictBool] = None,
+ issuer_override: Optional[StrictStr] = None,
+ logout_method: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ name_id_mapping: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session_valid_not_on_or_after: Optional[StrictStr] = None,
+ sign_assertion: Optional[StrictBool] = None,
+ sign_logout_request: Optional[StrictBool] = None,
+ sign_logout_response: Optional[StrictBool] = None,
+ sign_response: Optional[StrictBool] = None,
+ signature_algorithm: Optional[SignatureAlgorithmEnum] = None,
+ signing_kp: Optional[UUID] = None,
+ sls_binding: Optional[Any] = None,
+ sls_url: Optional[StrictStr] = None,
+ sp_binding: Optional[Any] = None,
+ verification_kp: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_list
+
+ SAMLProvider Viewset
+
+ :param acs_url:
+ :type acs_url: str
+ :param assertion_valid_not_before:
+ :type assertion_valid_not_before: str
+ :param assertion_valid_not_on_or_after:
+ :type assertion_valid_not_on_or_after: str
+ :param audience:
+ :type audience: str
+ :param authentication_flow:
+ :type authentication_flow: UUID
+ :param authn_context_class_ref_mapping:
+ :type authn_context_class_ref_mapping: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param backchannel_application:
+ :type backchannel_application: UUID
+ :param default_name_id_policy:
+ :type default_name_id_policy: SAMLNameIDPolicyEnum
+ :param default_relay_state:
+ :type default_relay_state: str
+ :param digest_algorithm:
+ :type digest_algorithm: DigestAlgorithmEnum
+ :param encryption_kp:
+ :type encryption_kp: UUID
+ :param invalidation_flow:
+ :type invalidation_flow: UUID
+ :param is_backchannel:
+ :type is_backchannel: bool
+ :param issuer_override:
+ :type issuer_override: str
+ :param logout_method:
+ :type logout_method: SAMLLogoutMethods
+ :param name:
+ :type name: str
+ :param name_id_mapping:
+ :type name_id_mapping: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param session_valid_not_on_or_after:
+ :type session_valid_not_on_or_after: str
+ :param sign_assertion:
+ :type sign_assertion: bool
+ :param sign_logout_request:
+ :type sign_logout_request: bool
+ :param sign_logout_response:
+ :type sign_logout_response: bool
+ :param sign_response:
+ :type sign_response: bool
+ :param signature_algorithm:
+ :type signature_algorithm: SignatureAlgorithmEnum
+ :param signing_kp:
+ :type signing_kp: UUID
+ :param sls_binding:
+ :type sls_binding: SAMLBindingsEnum
+ :param sls_url:
+ :type sls_url: str
+ :param sp_binding:
+ :type sp_binding: SAMLBindingsEnum
+ :param verification_kp:
+ :type verification_kp: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_list_serialize(
+ acs_url=acs_url,
+ assertion_valid_not_before=assertion_valid_not_before,
+ assertion_valid_not_on_or_after=assertion_valid_not_on_or_after,
+ audience=audience,
+ authentication_flow=authentication_flow,
+ authn_context_class_ref_mapping=authn_context_class_ref_mapping,
+ authorization_flow=authorization_flow,
+ backchannel_application=backchannel_application,
+ default_name_id_policy=default_name_id_policy,
+ default_relay_state=default_relay_state,
+ digest_algorithm=digest_algorithm,
+ encryption_kp=encryption_kp,
+ invalidation_flow=invalidation_flow,
+ is_backchannel=is_backchannel,
+ issuer_override=issuer_override,
+ logout_method=logout_method,
+ name=name,
+ name_id_mapping=name_id_mapping,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ search=search,
+ session_valid_not_on_or_after=session_valid_not_on_or_after,
+ sign_assertion=sign_assertion,
+ sign_logout_request=sign_logout_request,
+ sign_logout_response=sign_logout_response,
+ sign_response=sign_response,
+ signature_algorithm=signature_algorithm,
+ signing_kp=signing_kp,
+ sls_binding=sls_binding,
+ sls_url=sls_url,
+ sp_binding=sp_binding,
+ verification_kp=verification_kp,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSAMLProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_list_serialize(
+ self,
+ acs_url,
+ assertion_valid_not_before,
+ assertion_valid_not_on_or_after,
+ audience,
+ authentication_flow,
+ authn_context_class_ref_mapping,
+ authorization_flow,
+ backchannel_application,
+ default_name_id_policy,
+ default_relay_state,
+ digest_algorithm,
+ encryption_kp,
+ invalidation_flow,
+ is_backchannel,
+ issuer_override,
+ logout_method,
+ name,
+ name_id_mapping,
+ ordering,
+ page,
+ page_size,
+ property_mappings,
+ search,
+ session_valid_not_on_or_after,
+ sign_assertion,
+ sign_logout_request,
+ sign_logout_response,
+ sign_response,
+ signature_algorithm,
+ signing_kp,
+ sls_binding,
+ sls_url,
+ sp_binding,
+ verification_kp,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'property_mappings': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if acs_url is not None:
+
+ _query_params.append(('acs_url', acs_url))
+
+ if assertion_valid_not_before is not None:
+
+ _query_params.append(('assertion_valid_not_before', assertion_valid_not_before))
+
+ if assertion_valid_not_on_or_after is not None:
+
+ _query_params.append(('assertion_valid_not_on_or_after', assertion_valid_not_on_or_after))
+
+ if audience is not None:
+
+ _query_params.append(('audience', audience))
+
+ if authentication_flow is not None:
+
+ _query_params.append(('authentication_flow', authentication_flow))
+
+ if authn_context_class_ref_mapping is not None:
+
+ _query_params.append(('authn_context_class_ref_mapping', authn_context_class_ref_mapping))
+
+ if authorization_flow is not None:
+
+ _query_params.append(('authorization_flow', authorization_flow))
+
+ if backchannel_application is not None:
+
+ _query_params.append(('backchannel_application', backchannel_application))
+
+ if default_name_id_policy is not None:
+
+ _query_params.append(('default_name_id_policy', default_name_id_policy.value))
+
+ if default_relay_state is not None:
+
+ _query_params.append(('default_relay_state', default_relay_state))
+
+ if digest_algorithm is not None:
+
+ _query_params.append(('digest_algorithm', digest_algorithm.value))
+
+ if encryption_kp is not None:
+
+ _query_params.append(('encryption_kp', encryption_kp))
+
+ if invalidation_flow is not None:
+
+ _query_params.append(('invalidation_flow', invalidation_flow))
+
+ if is_backchannel is not None:
+
+ _query_params.append(('is_backchannel', is_backchannel))
+
+ if issuer_override is not None:
+
+ _query_params.append(('issuer_override', issuer_override))
+
+ if logout_method is not None:
+
+ _query_params.append(('logout_method', logout_method.value))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if name_id_mapping is not None:
+
+ _query_params.append(('name_id_mapping', name_id_mapping))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if property_mappings is not None:
+
+ _query_params.append(('property_mappings', property_mappings))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if session_valid_not_on_or_after is not None:
+
+ _query_params.append(('session_valid_not_on_or_after', session_valid_not_on_or_after))
+
+ if sign_assertion is not None:
+
+ _query_params.append(('sign_assertion', sign_assertion))
+
+ if sign_logout_request is not None:
+
+ _query_params.append(('sign_logout_request', sign_logout_request))
+
+ if sign_logout_response is not None:
+
+ _query_params.append(('sign_logout_response', sign_logout_response))
+
+ if sign_response is not None:
+
+ _query_params.append(('sign_response', sign_response))
+
+ if signature_algorithm is not None:
+
+ _query_params.append(('signature_algorithm', signature_algorithm.value))
+
+ if signing_kp is not None:
+
+ _query_params.append(('signing_kp', signing_kp))
+
+ if sls_binding is not None:
+
+ _query_params.append(('sls_binding', sls_binding.value))
+
+ if sls_url is not None:
+
+ _query_params.append(('sls_url', sls_url))
+
+ if sp_binding is not None:
+
+ _query_params.append(('sp_binding', sp_binding.value))
+
+ if verification_kp is not None:
+
+ _query_params.append(('verification_kp', verification_kp))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/saml/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_metadata_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ download: Optional[StrictBool] = None,
+ force_binding: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLMetadata:
+ """providers_saml_metadata_retrieve
+
+ Return metadata as XML string
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param download:
+ :type download: bool
+ :param force_binding:
+ :type force_binding: ForceBindingEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_metadata_retrieve_serialize(
+ id=id,
+ download=download,
+ force_binding=force_binding,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLMetadata",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_metadata_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ download: Optional[StrictBool] = None,
+ force_binding: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLMetadata]:
+ """providers_saml_metadata_retrieve
+
+ Return metadata as XML string
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param download:
+ :type download: bool
+ :param force_binding:
+ :type force_binding: ForceBindingEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_metadata_retrieve_serialize(
+ id=id,
+ download=download,
+ force_binding=force_binding,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLMetadata",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_metadata_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ download: Optional[StrictBool] = None,
+ force_binding: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_metadata_retrieve
+
+ Return metadata as XML string
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param download:
+ :type download: bool
+ :param force_binding:
+ :type force_binding: ForceBindingEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_metadata_retrieve_serialize(
+ id=id,
+ download=download,
+ force_binding=force_binding,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLMetadata",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_metadata_retrieve_serialize(
+ self,
+ id,
+ download,
+ force_binding,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if download is not None:
+
+ _query_params.append(('download', download))
+
+ if force_binding is not None:
+
+ _query_params.append(('force_binding', force_binding.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json',
+ 'application/xml'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/saml/{id}/metadata/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ patched_saml_provider_request: Optional[PatchedSAMLProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLProvider:
+ """providers_saml_partial_update
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param patched_saml_provider_request:
+ :type patched_saml_provider_request: PatchedSAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_partial_update_serialize(
+ id=id,
+ patched_saml_provider_request=patched_saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ patched_saml_provider_request: Optional[PatchedSAMLProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLProvider]:
+ """providers_saml_partial_update
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param patched_saml_provider_request:
+ :type patched_saml_provider_request: PatchedSAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_partial_update_serialize(
+ id=id,
+ patched_saml_provider_request=patched_saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ patched_saml_provider_request: Optional[PatchedSAMLProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_partial_update
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param patched_saml_provider_request:
+ :type patched_saml_provider_request: PatchedSAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_partial_update_serialize(
+ id=id,
+ patched_saml_provider_request=patched_saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_partial_update_serialize(
+ self,
+ id,
+ patched_saml_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_saml_provider_request is not None:
+ _body_params = patched_saml_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/saml/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_preview_user_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PropertyMappingPreview:
+ """providers_saml_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_preview_user_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PropertyMappingPreview]:
+ """providers_saml_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_preview_user_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_preview_user_retrieve_serialize(
+ self,
+ id,
+ for_user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if for_user is not None:
+
+ _query_params.append(('for_user', for_user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/saml/{id}/preview_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLProvider:
+ """providers_saml_retrieve
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLProvider]:
+ """providers_saml_retrieve
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_retrieve
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/saml/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ saml_provider_request: SAMLProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLProvider:
+ """providers_saml_update
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param saml_provider_request: (required)
+ :type saml_provider_request: SAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_update_serialize(
+ id=id,
+ saml_provider_request=saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ saml_provider_request: SAMLProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLProvider]:
+ """providers_saml_update
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param saml_provider_request: (required)
+ :type saml_provider_request: SAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_update_serialize(
+ id=id,
+ saml_provider_request=saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ saml_provider_request: SAMLProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_update
+
+ SAMLProvider Viewset
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param saml_provider_request: (required)
+ :type saml_provider_request: SAMLProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_update_serialize(
+ id=id,
+ saml_provider_request=saml_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_update_serialize(
+ self,
+ id,
+ saml_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if saml_provider_request is not None:
+ _body_params = saml_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/saml/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_saml_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_saml_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_saml_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SAML Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_saml_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SAML Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_saml_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_saml_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/saml/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_create(
+ self,
+ scim_provider_request: SCIMProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProvider:
+ """providers_scim_create
+
+ SCIMProvider Viewset
+
+ :param scim_provider_request: (required)
+ :type scim_provider_request: SCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_create_serialize(
+ scim_provider_request=scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_create_with_http_info(
+ self,
+ scim_provider_request: SCIMProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProvider]:
+ """providers_scim_create
+
+ SCIMProvider Viewset
+
+ :param scim_provider_request: (required)
+ :type scim_provider_request: SCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_create_serialize(
+ scim_provider_request=scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_create_without_preload_content(
+ self,
+ scim_provider_request: SCIMProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_create
+
+ SCIMProvider Viewset
+
+ :param scim_provider_request: (required)
+ :type scim_provider_request: SCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_create_serialize(
+ scim_provider_request=scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_create_serialize(
+ self,
+ scim_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_provider_request is not None:
+ _body_params = scim_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/scim/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_scim_destroy
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_scim_destroy
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_destroy
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/scim/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_groups_create(
+ self,
+ scim_provider_group_request: SCIMProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProviderGroup:
+ """providers_scim_groups_create
+
+ SCIMProviderGroup Viewset
+
+ :param scim_provider_group_request: (required)
+ :type scim_provider_group_request: SCIMProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_create_serialize(
+ scim_provider_group_request=scim_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_groups_create_with_http_info(
+ self,
+ scim_provider_group_request: SCIMProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProviderGroup]:
+ """providers_scim_groups_create
+
+ SCIMProviderGroup Viewset
+
+ :param scim_provider_group_request: (required)
+ :type scim_provider_group_request: SCIMProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_create_serialize(
+ scim_provider_group_request=scim_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_groups_create_without_preload_content(
+ self,
+ scim_provider_group_request: SCIMProviderGroupRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_groups_create
+
+ SCIMProviderGroup Viewset
+
+ :param scim_provider_group_request: (required)
+ :type scim_provider_group_request: SCIMProviderGroupRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_create_serialize(
+ scim_provider_group_request=scim_provider_group_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_groups_create_serialize(
+ self,
+ scim_provider_group_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_provider_group_request is not None:
+ _body_params = scim_provider_group_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/scim_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_groups_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_scim_groups_destroy
+
+ SCIMProviderGroup Viewset
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_groups_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_scim_groups_destroy
+
+ SCIMProviderGroup Viewset
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_groups_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_groups_destroy
+
+ SCIMProviderGroup Viewset
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_groups_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/scim_groups/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_groups_list(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSCIMProviderGroupList:
+ """providers_scim_groups_list
+
+ SCIMProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_groups_list_with_http_info(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSCIMProviderGroupList]:
+ """providers_scim_groups_list
+
+ SCIMProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_groups_list_without_preload_content(
+ self,
+ group__group_uuid: Optional[UUID] = None,
+ group__name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_groups_list
+
+ SCIMProviderGroup Viewset
+
+ :param group__group_uuid:
+ :type group__group_uuid: UUID
+ :param group__name:
+ :type group__name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_list_serialize(
+ group__group_uuid=group__group_uuid,
+ group__name=group__name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderGroupList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_groups_list_serialize(
+ self,
+ group__group_uuid,
+ group__name,
+ ordering,
+ page,
+ page_size,
+ provider__id,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if group__group_uuid is not None:
+
+ _query_params.append(('group__group_uuid', group__group_uuid))
+
+ if group__name is not None:
+
+ _query_params.append(('group__name', group__name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider__id is not None:
+
+ _query_params.append(('provider__id', provider__id))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim_groups/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_groups_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProviderGroup:
+ """providers_scim_groups_retrieve
+
+ SCIMProviderGroup Viewset
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_groups_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProviderGroup]:
+ """providers_scim_groups_retrieve
+
+ SCIMProviderGroup Viewset
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_groups_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_groups_retrieve
+
+ SCIMProviderGroup Viewset
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProviderGroup",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_groups_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim_groups/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_groups_used_by_list(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_scim_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_groups_used_by_list_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_scim_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_groups_used_by_list_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider group.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_groups_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this scim provider group. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_groups_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_groups_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim_groups/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_list(
+ self,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ group_filters: Optional[List[UUID]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSCIMProviderList:
+ """providers_scim_list
+
+ SCIMProvider Viewset
+
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param group_filters:
+ :type group_filters: List[UUID]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param url:
+ :type url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_list_serialize(
+ exclude_users_service_account=exclude_users_service_account,
+ group_filters=group_filters,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ url=url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_list_with_http_info(
+ self,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ group_filters: Optional[List[UUID]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSCIMProviderList]:
+ """providers_scim_list
+
+ SCIMProvider Viewset
+
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param group_filters:
+ :type group_filters: List[UUID]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param url:
+ :type url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_list_serialize(
+ exclude_users_service_account=exclude_users_service_account,
+ group_filters=group_filters,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ url=url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_list_without_preload_content(
+ self,
+ exclude_users_service_account: Optional[StrictBool] = None,
+ group_filters: Optional[List[UUID]] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ url: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_list
+
+ SCIMProvider Viewset
+
+ :param exclude_users_service_account:
+ :type exclude_users_service_account: bool
+ :param group_filters:
+ :type group_filters: List[UUID]
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param url:
+ :type url: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_list_serialize(
+ exclude_users_service_account=exclude_users_service_account,
+ group_filters=group_filters,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ url=url,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_list_serialize(
+ self,
+ exclude_users_service_account,
+ group_filters,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ url,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'group_filters': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if exclude_users_service_account is not None:
+
+ _query_params.append(('exclude_users_service_account', exclude_users_service_account))
+
+ if group_filters is not None:
+
+ _query_params.append(('group_filters', group_filters))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if url is not None:
+
+ _query_params.append(('url', url))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ patched_scim_provider_request: Optional[PatchedSCIMProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProvider:
+ """providers_scim_partial_update
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param patched_scim_provider_request:
+ :type patched_scim_provider_request: PatchedSCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_partial_update_serialize(
+ id=id,
+ patched_scim_provider_request=patched_scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ patched_scim_provider_request: Optional[PatchedSCIMProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProvider]:
+ """providers_scim_partial_update
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param patched_scim_provider_request:
+ :type patched_scim_provider_request: PatchedSCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_partial_update_serialize(
+ id=id,
+ patched_scim_provider_request=patched_scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ patched_scim_provider_request: Optional[PatchedSCIMProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_partial_update
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param patched_scim_provider_request:
+ :type patched_scim_provider_request: PatchedSCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_partial_update_serialize(
+ id=id,
+ patched_scim_provider_request=patched_scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_partial_update_serialize(
+ self,
+ id,
+ patched_scim_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_scim_provider_request is not None:
+ _body_params = patched_scim_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/scim/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProvider:
+ """providers_scim_retrieve
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProvider]:
+ """providers_scim_retrieve
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_retrieve
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_sync_object_create(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SyncObjectResult:
+ """providers_scim_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_sync_object_create_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SyncObjectResult]:
+ """providers_scim_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_sync_object_create_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ sync_object_request: SyncObjectRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_sync_object_create
+
+ Sync/Re-sync a single user/group object
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param sync_object_request: (required)
+ :type sync_object_request: SyncObjectRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_sync_object_create_serialize(
+ id=id,
+ sync_object_request=sync_object_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncObjectResult",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_sync_object_create_serialize(
+ self,
+ id,
+ sync_object_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if sync_object_request is not None:
+ _body_params = sync_object_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/scim/{id}/sync/object/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_sync_status_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SyncStatus:
+ """providers_scim_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_sync_status_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SyncStatus]:
+ """providers_scim_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_sync_status_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_sync_status_retrieve
+
+ Get provider's sync status
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_sync_status_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SyncStatus",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_sync_status_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim/{id}/sync/status/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ scim_provider_request: SCIMProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProvider:
+ """providers_scim_update
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param scim_provider_request: (required)
+ :type scim_provider_request: SCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_update_serialize(
+ id=id,
+ scim_provider_request=scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ scim_provider_request: SCIMProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProvider]:
+ """providers_scim_update
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param scim_provider_request: (required)
+ :type scim_provider_request: SCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_update_serialize(
+ id=id,
+ scim_provider_request=scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ scim_provider_request: SCIMProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_update
+
+ SCIMProvider Viewset
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param scim_provider_request: (required)
+ :type scim_provider_request: SCIMProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_update_serialize(
+ id=id,
+ scim_provider_request=scim_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_update_serialize(
+ self,
+ id,
+ scim_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_provider_request is not None:
+ _body_params = scim_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/scim/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this SCIM Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this SCIM Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_users_create(
+ self,
+ scim_provider_user_request: SCIMProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProviderUser:
+ """providers_scim_users_create
+
+ SCIMProviderUser Viewset
+
+ :param scim_provider_user_request: (required)
+ :type scim_provider_user_request: SCIMProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_create_serialize(
+ scim_provider_user_request=scim_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_users_create_with_http_info(
+ self,
+ scim_provider_user_request: SCIMProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProviderUser]:
+ """providers_scim_users_create
+
+ SCIMProviderUser Viewset
+
+ :param scim_provider_user_request: (required)
+ :type scim_provider_user_request: SCIMProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_create_serialize(
+ scim_provider_user_request=scim_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_users_create_without_preload_content(
+ self,
+ scim_provider_user_request: SCIMProviderUserRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_users_create
+
+ SCIMProviderUser Viewset
+
+ :param scim_provider_user_request: (required)
+ :type scim_provider_user_request: SCIMProviderUserRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_create_serialize(
+ scim_provider_user_request=scim_provider_user_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SCIMProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_users_create_serialize(
+ self,
+ scim_provider_user_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if scim_provider_user_request is not None:
+ _body_params = scim_provider_user_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/scim_users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_users_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_scim_users_destroy
+
+ SCIMProviderUser Viewset
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_users_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_scim_users_destroy
+
+ SCIMProviderUser Viewset
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_users_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_users_destroy
+
+ SCIMProviderUser Viewset
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_users_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/scim_users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_users_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSCIMProviderUserList:
+ """providers_scim_users_list
+
+ SCIMProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_users_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSCIMProviderUserList]:
+ """providers_scim_users_list
+
+ SCIMProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_users_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider__id: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ user__id: Optional[StrictInt] = None,
+ user__username: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_users_list
+
+ SCIMProviderUser Viewset
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider__id:
+ :type provider__id: int
+ :param search: A search term.
+ :type search: str
+ :param user__id:
+ :type user__id: int
+ :param user__username:
+ :type user__username: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider__id=provider__id,
+ search=search,
+ user__id=user__id,
+ user__username=user__username,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSCIMProviderUserList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_users_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ provider__id,
+ search,
+ user__id,
+ user__username,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider__id is not None:
+
+ _query_params.append(('provider__id', provider__id))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if user__id is not None:
+
+ _query_params.append(('user__id', user__id))
+
+ if user__username is not None:
+
+ _query_params.append(('user__username', user__username))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim_users/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_users_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SCIMProviderUser:
+ """providers_scim_users_retrieve
+
+ SCIMProviderUser Viewset
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_users_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SCIMProviderUser]:
+ """providers_scim_users_retrieve
+
+ SCIMProviderUser Viewset
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_users_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_users_retrieve
+
+ SCIMProviderUser Viewset
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SCIMProviderUser",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_users_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim_users/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_scim_users_used_by_list(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_scim_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_scim_users_used_by_list_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_scim_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_scim_users_used_by_list_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this scim provider user.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_scim_users_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A UUID string identifying this scim provider user. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_scim_users_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_scim_users_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/scim_users/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_create(
+ self,
+ ssf_provider_request: SSFProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SSFProvider:
+ """providers_ssf_create
+
+ SSFProvider Viewset
+
+ :param ssf_provider_request: (required)
+ :type ssf_provider_request: SSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_create_serialize(
+ ssf_provider_request=ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_create_with_http_info(
+ self,
+ ssf_provider_request: SSFProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SSFProvider]:
+ """providers_ssf_create
+
+ SSFProvider Viewset
+
+ :param ssf_provider_request: (required)
+ :type ssf_provider_request: SSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_create_serialize(
+ ssf_provider_request=ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_create_without_preload_content(
+ self,
+ ssf_provider_request: SSFProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_create
+
+ SSFProvider Viewset
+
+ :param ssf_provider_request: (required)
+ :type ssf_provider_request: SSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_create_serialize(
+ ssf_provider_request=ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_create_serialize(
+ self,
+ ssf_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ssf_provider_request is not None:
+ _body_params = ssf_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/ssf/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_ssf_destroy
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_ssf_destroy
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_destroy
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/ssf/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_list(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSSFProviderList:
+ """providers_ssf_list
+
+ SSFProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_list_serialize(
+ application__isnull=application__isnull,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSSFProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_list_with_http_info(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSSFProviderList]:
+ """providers_ssf_list
+
+ SSFProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_list_serialize(
+ application__isnull=application__isnull,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSSFProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_list_without_preload_content(
+ self,
+ application__isnull: Optional[StrictBool] = None,
+ name__iexact: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_list
+
+ SSFProvider Viewset
+
+ :param application__isnull:
+ :type application__isnull: bool
+ :param name__iexact:
+ :type name__iexact: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_list_serialize(
+ application__isnull=application__isnull,
+ name__iexact=name__iexact,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSSFProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_list_serialize(
+ self,
+ application__isnull,
+ name__iexact,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if application__isnull is not None:
+
+ _query_params.append(('application__isnull', application__isnull))
+
+ if name__iexact is not None:
+
+ _query_params.append(('name__iexact', name__iexact))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/ssf/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ patched_ssf_provider_request: Optional[PatchedSSFProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SSFProvider:
+ """providers_ssf_partial_update
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param patched_ssf_provider_request:
+ :type patched_ssf_provider_request: PatchedSSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_partial_update_serialize(
+ id=id,
+ patched_ssf_provider_request=patched_ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ patched_ssf_provider_request: Optional[PatchedSSFProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SSFProvider]:
+ """providers_ssf_partial_update
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param patched_ssf_provider_request:
+ :type patched_ssf_provider_request: PatchedSSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_partial_update_serialize(
+ id=id,
+ patched_ssf_provider_request=patched_ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ patched_ssf_provider_request: Optional[PatchedSSFProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_partial_update
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param patched_ssf_provider_request:
+ :type patched_ssf_provider_request: PatchedSSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_partial_update_serialize(
+ id=id,
+ patched_ssf_provider_request=patched_ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_partial_update_serialize(
+ self,
+ id,
+ patched_ssf_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_ssf_provider_request is not None:
+ _body_params = patched_ssf_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/ssf/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SSFProvider:
+ """providers_ssf_retrieve
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SSFProvider]:
+ """providers_ssf_retrieve
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_retrieve
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/ssf/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ ssf_provider_request: SSFProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SSFProvider:
+ """providers_ssf_update
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param ssf_provider_request: (required)
+ :type ssf_provider_request: SSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_update_serialize(
+ id=id,
+ ssf_provider_request=ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ ssf_provider_request: SSFProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SSFProvider]:
+ """providers_ssf_update
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param ssf_provider_request: (required)
+ :type ssf_provider_request: SSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_update_serialize(
+ id=id,
+ ssf_provider_request=ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ ssf_provider_request: SSFProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_update
+
+ SSFProvider Viewset
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param ssf_provider_request: (required)
+ :type ssf_provider_request: SSFProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_update_serialize(
+ id=id,
+ ssf_provider_request=ssf_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SSFProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_update_serialize(
+ self,
+ id,
+ ssf_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ssf_provider_request is not None:
+ _body_params = ssf_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/ssf/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_ssf_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_ssf_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_ssf_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_ssf_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_ssf_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Shared Signals Framework Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_ssf_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Shared Signals Framework Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_ssf_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_ssf_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/ssf/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_create(
+ self,
+ ws_federation_provider_request: WSFederationProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WSFederationProvider:
+ """providers_wsfed_create
+
+ WSFederationProvider Viewset
+
+ :param ws_federation_provider_request: (required)
+ :type ws_federation_provider_request: WSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_create_serialize(
+ ws_federation_provider_request=ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_create_with_http_info(
+ self,
+ ws_federation_provider_request: WSFederationProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WSFederationProvider]:
+ """providers_wsfed_create
+
+ WSFederationProvider Viewset
+
+ :param ws_federation_provider_request: (required)
+ :type ws_federation_provider_request: WSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_create_serialize(
+ ws_federation_provider_request=ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_create_without_preload_content(
+ self,
+ ws_federation_provider_request: WSFederationProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_create
+
+ WSFederationProvider Viewset
+
+ :param ws_federation_provider_request: (required)
+ :type ws_federation_provider_request: WSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_create_serialize(
+ ws_federation_provider_request=ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_create_serialize(
+ self,
+ ws_federation_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ws_federation_provider_request is not None:
+ _body_params = ws_federation_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/providers/wsfed/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """providers_wsfed_destroy
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """providers_wsfed_destroy
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_destroy
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/providers/wsfed/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_list(
+ self,
+ acs_url: Optional[StrictStr] = None,
+ assertion_valid_not_before: Optional[StrictStr] = None,
+ assertion_valid_not_on_or_after: Optional[StrictStr] = None,
+ audience: Optional[StrictStr] = None,
+ authentication_flow: Optional[UUID] = None,
+ authn_context_class_ref_mapping: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ backchannel_application: Optional[UUID] = None,
+ default_name_id_policy: Optional[SAMLNameIDPolicyEnum] = None,
+ default_relay_state: Optional[StrictStr] = None,
+ digest_algorithm: Optional[DigestAlgorithmEnum] = None,
+ encryption_kp: Optional[UUID] = None,
+ invalidation_flow: Optional[UUID] = None,
+ is_backchannel: Optional[StrictBool] = None,
+ issuer_override: Optional[StrictStr] = None,
+ logout_method: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ name_id_mapping: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session_valid_not_on_or_after: Optional[StrictStr] = None,
+ sign_assertion: Optional[StrictBool] = None,
+ sign_logout_request: Optional[StrictBool] = None,
+ sign_logout_response: Optional[StrictBool] = None,
+ sign_response: Optional[StrictBool] = None,
+ signature_algorithm: Optional[SignatureAlgorithmEnum] = None,
+ signing_kp: Optional[UUID] = None,
+ sls_binding: Optional[Any] = None,
+ sls_url: Optional[StrictStr] = None,
+ sp_binding: Optional[Any] = None,
+ verification_kp: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedWSFederationProviderList:
+ """providers_wsfed_list
+
+ WSFederationProvider Viewset
+
+ :param acs_url:
+ :type acs_url: str
+ :param assertion_valid_not_before:
+ :type assertion_valid_not_before: str
+ :param assertion_valid_not_on_or_after:
+ :type assertion_valid_not_on_or_after: str
+ :param audience:
+ :type audience: str
+ :param authentication_flow:
+ :type authentication_flow: UUID
+ :param authn_context_class_ref_mapping:
+ :type authn_context_class_ref_mapping: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param backchannel_application:
+ :type backchannel_application: UUID
+ :param default_name_id_policy:
+ :type default_name_id_policy: SAMLNameIDPolicyEnum
+ :param default_relay_state:
+ :type default_relay_state: str
+ :param digest_algorithm:
+ :type digest_algorithm: DigestAlgorithmEnum
+ :param encryption_kp:
+ :type encryption_kp: UUID
+ :param invalidation_flow:
+ :type invalidation_flow: UUID
+ :param is_backchannel:
+ :type is_backchannel: bool
+ :param issuer_override:
+ :type issuer_override: str
+ :param logout_method:
+ :type logout_method: SAMLLogoutMethods
+ :param name:
+ :type name: str
+ :param name_id_mapping:
+ :type name_id_mapping: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param session_valid_not_on_or_after:
+ :type session_valid_not_on_or_after: str
+ :param sign_assertion:
+ :type sign_assertion: bool
+ :param sign_logout_request:
+ :type sign_logout_request: bool
+ :param sign_logout_response:
+ :type sign_logout_response: bool
+ :param sign_response:
+ :type sign_response: bool
+ :param signature_algorithm:
+ :type signature_algorithm: SignatureAlgorithmEnum
+ :param signing_kp:
+ :type signing_kp: UUID
+ :param sls_binding:
+ :type sls_binding: SAMLBindingsEnum
+ :param sls_url:
+ :type sls_url: str
+ :param sp_binding:
+ :type sp_binding: SAMLBindingsEnum
+ :param verification_kp:
+ :type verification_kp: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_list_serialize(
+ acs_url=acs_url,
+ assertion_valid_not_before=assertion_valid_not_before,
+ assertion_valid_not_on_or_after=assertion_valid_not_on_or_after,
+ audience=audience,
+ authentication_flow=authentication_flow,
+ authn_context_class_ref_mapping=authn_context_class_ref_mapping,
+ authorization_flow=authorization_flow,
+ backchannel_application=backchannel_application,
+ default_name_id_policy=default_name_id_policy,
+ default_relay_state=default_relay_state,
+ digest_algorithm=digest_algorithm,
+ encryption_kp=encryption_kp,
+ invalidation_flow=invalidation_flow,
+ is_backchannel=is_backchannel,
+ issuer_override=issuer_override,
+ logout_method=logout_method,
+ name=name,
+ name_id_mapping=name_id_mapping,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ search=search,
+ session_valid_not_on_or_after=session_valid_not_on_or_after,
+ sign_assertion=sign_assertion,
+ sign_logout_request=sign_logout_request,
+ sign_logout_response=sign_logout_response,
+ sign_response=sign_response,
+ signature_algorithm=signature_algorithm,
+ signing_kp=signing_kp,
+ sls_binding=sls_binding,
+ sls_url=sls_url,
+ sp_binding=sp_binding,
+ verification_kp=verification_kp,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWSFederationProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_list_with_http_info(
+ self,
+ acs_url: Optional[StrictStr] = None,
+ assertion_valid_not_before: Optional[StrictStr] = None,
+ assertion_valid_not_on_or_after: Optional[StrictStr] = None,
+ audience: Optional[StrictStr] = None,
+ authentication_flow: Optional[UUID] = None,
+ authn_context_class_ref_mapping: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ backchannel_application: Optional[UUID] = None,
+ default_name_id_policy: Optional[SAMLNameIDPolicyEnum] = None,
+ default_relay_state: Optional[StrictStr] = None,
+ digest_algorithm: Optional[DigestAlgorithmEnum] = None,
+ encryption_kp: Optional[UUID] = None,
+ invalidation_flow: Optional[UUID] = None,
+ is_backchannel: Optional[StrictBool] = None,
+ issuer_override: Optional[StrictStr] = None,
+ logout_method: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ name_id_mapping: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session_valid_not_on_or_after: Optional[StrictStr] = None,
+ sign_assertion: Optional[StrictBool] = None,
+ sign_logout_request: Optional[StrictBool] = None,
+ sign_logout_response: Optional[StrictBool] = None,
+ sign_response: Optional[StrictBool] = None,
+ signature_algorithm: Optional[SignatureAlgorithmEnum] = None,
+ signing_kp: Optional[UUID] = None,
+ sls_binding: Optional[Any] = None,
+ sls_url: Optional[StrictStr] = None,
+ sp_binding: Optional[Any] = None,
+ verification_kp: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedWSFederationProviderList]:
+ """providers_wsfed_list
+
+ WSFederationProvider Viewset
+
+ :param acs_url:
+ :type acs_url: str
+ :param assertion_valid_not_before:
+ :type assertion_valid_not_before: str
+ :param assertion_valid_not_on_or_after:
+ :type assertion_valid_not_on_or_after: str
+ :param audience:
+ :type audience: str
+ :param authentication_flow:
+ :type authentication_flow: UUID
+ :param authn_context_class_ref_mapping:
+ :type authn_context_class_ref_mapping: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param backchannel_application:
+ :type backchannel_application: UUID
+ :param default_name_id_policy:
+ :type default_name_id_policy: SAMLNameIDPolicyEnum
+ :param default_relay_state:
+ :type default_relay_state: str
+ :param digest_algorithm:
+ :type digest_algorithm: DigestAlgorithmEnum
+ :param encryption_kp:
+ :type encryption_kp: UUID
+ :param invalidation_flow:
+ :type invalidation_flow: UUID
+ :param is_backchannel:
+ :type is_backchannel: bool
+ :param issuer_override:
+ :type issuer_override: str
+ :param logout_method:
+ :type logout_method: SAMLLogoutMethods
+ :param name:
+ :type name: str
+ :param name_id_mapping:
+ :type name_id_mapping: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param session_valid_not_on_or_after:
+ :type session_valid_not_on_or_after: str
+ :param sign_assertion:
+ :type sign_assertion: bool
+ :param sign_logout_request:
+ :type sign_logout_request: bool
+ :param sign_logout_response:
+ :type sign_logout_response: bool
+ :param sign_response:
+ :type sign_response: bool
+ :param signature_algorithm:
+ :type signature_algorithm: SignatureAlgorithmEnum
+ :param signing_kp:
+ :type signing_kp: UUID
+ :param sls_binding:
+ :type sls_binding: SAMLBindingsEnum
+ :param sls_url:
+ :type sls_url: str
+ :param sp_binding:
+ :type sp_binding: SAMLBindingsEnum
+ :param verification_kp:
+ :type verification_kp: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_list_serialize(
+ acs_url=acs_url,
+ assertion_valid_not_before=assertion_valid_not_before,
+ assertion_valid_not_on_or_after=assertion_valid_not_on_or_after,
+ audience=audience,
+ authentication_flow=authentication_flow,
+ authn_context_class_ref_mapping=authn_context_class_ref_mapping,
+ authorization_flow=authorization_flow,
+ backchannel_application=backchannel_application,
+ default_name_id_policy=default_name_id_policy,
+ default_relay_state=default_relay_state,
+ digest_algorithm=digest_algorithm,
+ encryption_kp=encryption_kp,
+ invalidation_flow=invalidation_flow,
+ is_backchannel=is_backchannel,
+ issuer_override=issuer_override,
+ logout_method=logout_method,
+ name=name,
+ name_id_mapping=name_id_mapping,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ search=search,
+ session_valid_not_on_or_after=session_valid_not_on_or_after,
+ sign_assertion=sign_assertion,
+ sign_logout_request=sign_logout_request,
+ sign_logout_response=sign_logout_response,
+ sign_response=sign_response,
+ signature_algorithm=signature_algorithm,
+ signing_kp=signing_kp,
+ sls_binding=sls_binding,
+ sls_url=sls_url,
+ sp_binding=sp_binding,
+ verification_kp=verification_kp,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWSFederationProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_list_without_preload_content(
+ self,
+ acs_url: Optional[StrictStr] = None,
+ assertion_valid_not_before: Optional[StrictStr] = None,
+ assertion_valid_not_on_or_after: Optional[StrictStr] = None,
+ audience: Optional[StrictStr] = None,
+ authentication_flow: Optional[UUID] = None,
+ authn_context_class_ref_mapping: Optional[UUID] = None,
+ authorization_flow: Optional[UUID] = None,
+ backchannel_application: Optional[UUID] = None,
+ default_name_id_policy: Optional[SAMLNameIDPolicyEnum] = None,
+ default_relay_state: Optional[StrictStr] = None,
+ digest_algorithm: Optional[DigestAlgorithmEnum] = None,
+ encryption_kp: Optional[UUID] = None,
+ invalidation_flow: Optional[UUID] = None,
+ is_backchannel: Optional[StrictBool] = None,
+ issuer_override: Optional[StrictStr] = None,
+ logout_method: Optional[Any] = None,
+ name: Optional[StrictStr] = None,
+ name_id_mapping: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ property_mappings: Optional[List[UUID]] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session_valid_not_on_or_after: Optional[StrictStr] = None,
+ sign_assertion: Optional[StrictBool] = None,
+ sign_logout_request: Optional[StrictBool] = None,
+ sign_logout_response: Optional[StrictBool] = None,
+ sign_response: Optional[StrictBool] = None,
+ signature_algorithm: Optional[SignatureAlgorithmEnum] = None,
+ signing_kp: Optional[UUID] = None,
+ sls_binding: Optional[Any] = None,
+ sls_url: Optional[StrictStr] = None,
+ sp_binding: Optional[Any] = None,
+ verification_kp: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_list
+
+ WSFederationProvider Viewset
+
+ :param acs_url:
+ :type acs_url: str
+ :param assertion_valid_not_before:
+ :type assertion_valid_not_before: str
+ :param assertion_valid_not_on_or_after:
+ :type assertion_valid_not_on_or_after: str
+ :param audience:
+ :type audience: str
+ :param authentication_flow:
+ :type authentication_flow: UUID
+ :param authn_context_class_ref_mapping:
+ :type authn_context_class_ref_mapping: UUID
+ :param authorization_flow:
+ :type authorization_flow: UUID
+ :param backchannel_application:
+ :type backchannel_application: UUID
+ :param default_name_id_policy:
+ :type default_name_id_policy: SAMLNameIDPolicyEnum
+ :param default_relay_state:
+ :type default_relay_state: str
+ :param digest_algorithm:
+ :type digest_algorithm: DigestAlgorithmEnum
+ :param encryption_kp:
+ :type encryption_kp: UUID
+ :param invalidation_flow:
+ :type invalidation_flow: UUID
+ :param is_backchannel:
+ :type is_backchannel: bool
+ :param issuer_override:
+ :type issuer_override: str
+ :param logout_method:
+ :type logout_method: SAMLLogoutMethods
+ :param name:
+ :type name: str
+ :param name_id_mapping:
+ :type name_id_mapping: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param property_mappings:
+ :type property_mappings: List[UUID]
+ :param search: A search term.
+ :type search: str
+ :param session_valid_not_on_or_after:
+ :type session_valid_not_on_or_after: str
+ :param sign_assertion:
+ :type sign_assertion: bool
+ :param sign_logout_request:
+ :type sign_logout_request: bool
+ :param sign_logout_response:
+ :type sign_logout_response: bool
+ :param sign_response:
+ :type sign_response: bool
+ :param signature_algorithm:
+ :type signature_algorithm: SignatureAlgorithmEnum
+ :param signing_kp:
+ :type signing_kp: UUID
+ :param sls_binding:
+ :type sls_binding: SAMLBindingsEnum
+ :param sls_url:
+ :type sls_url: str
+ :param sp_binding:
+ :type sp_binding: SAMLBindingsEnum
+ :param verification_kp:
+ :type verification_kp: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_list_serialize(
+ acs_url=acs_url,
+ assertion_valid_not_before=assertion_valid_not_before,
+ assertion_valid_not_on_or_after=assertion_valid_not_on_or_after,
+ audience=audience,
+ authentication_flow=authentication_flow,
+ authn_context_class_ref_mapping=authn_context_class_ref_mapping,
+ authorization_flow=authorization_flow,
+ backchannel_application=backchannel_application,
+ default_name_id_policy=default_name_id_policy,
+ default_relay_state=default_relay_state,
+ digest_algorithm=digest_algorithm,
+ encryption_kp=encryption_kp,
+ invalidation_flow=invalidation_flow,
+ is_backchannel=is_backchannel,
+ issuer_override=issuer_override,
+ logout_method=logout_method,
+ name=name,
+ name_id_mapping=name_id_mapping,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ property_mappings=property_mappings,
+ search=search,
+ session_valid_not_on_or_after=session_valid_not_on_or_after,
+ sign_assertion=sign_assertion,
+ sign_logout_request=sign_logout_request,
+ sign_logout_response=sign_logout_response,
+ sign_response=sign_response,
+ signature_algorithm=signature_algorithm,
+ signing_kp=signing_kp,
+ sls_binding=sls_binding,
+ sls_url=sls_url,
+ sp_binding=sp_binding,
+ verification_kp=verification_kp,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedWSFederationProviderList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_list_serialize(
+ self,
+ acs_url,
+ assertion_valid_not_before,
+ assertion_valid_not_on_or_after,
+ audience,
+ authentication_flow,
+ authn_context_class_ref_mapping,
+ authorization_flow,
+ backchannel_application,
+ default_name_id_policy,
+ default_relay_state,
+ digest_algorithm,
+ encryption_kp,
+ invalidation_flow,
+ is_backchannel,
+ issuer_override,
+ logout_method,
+ name,
+ name_id_mapping,
+ ordering,
+ page,
+ page_size,
+ property_mappings,
+ search,
+ session_valid_not_on_or_after,
+ sign_assertion,
+ sign_logout_request,
+ sign_logout_response,
+ sign_response,
+ signature_algorithm,
+ signing_kp,
+ sls_binding,
+ sls_url,
+ sp_binding,
+ verification_kp,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'property_mappings': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if acs_url is not None:
+
+ _query_params.append(('acs_url', acs_url))
+
+ if assertion_valid_not_before is not None:
+
+ _query_params.append(('assertion_valid_not_before', assertion_valid_not_before))
+
+ if assertion_valid_not_on_or_after is not None:
+
+ _query_params.append(('assertion_valid_not_on_or_after', assertion_valid_not_on_or_after))
+
+ if audience is not None:
+
+ _query_params.append(('audience', audience))
+
+ if authentication_flow is not None:
+
+ _query_params.append(('authentication_flow', authentication_flow))
+
+ if authn_context_class_ref_mapping is not None:
+
+ _query_params.append(('authn_context_class_ref_mapping', authn_context_class_ref_mapping))
+
+ if authorization_flow is not None:
+
+ _query_params.append(('authorization_flow', authorization_flow))
+
+ if backchannel_application is not None:
+
+ _query_params.append(('backchannel_application', backchannel_application))
+
+ if default_name_id_policy is not None:
+
+ _query_params.append(('default_name_id_policy', default_name_id_policy.value))
+
+ if default_relay_state is not None:
+
+ _query_params.append(('default_relay_state', default_relay_state))
+
+ if digest_algorithm is not None:
+
+ _query_params.append(('digest_algorithm', digest_algorithm.value))
+
+ if encryption_kp is not None:
+
+ _query_params.append(('encryption_kp', encryption_kp))
+
+ if invalidation_flow is not None:
+
+ _query_params.append(('invalidation_flow', invalidation_flow))
+
+ if is_backchannel is not None:
+
+ _query_params.append(('is_backchannel', is_backchannel))
+
+ if issuer_override is not None:
+
+ _query_params.append(('issuer_override', issuer_override))
+
+ if logout_method is not None:
+
+ _query_params.append(('logout_method', logout_method.value))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if name_id_mapping is not None:
+
+ _query_params.append(('name_id_mapping', name_id_mapping))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if property_mappings is not None:
+
+ _query_params.append(('property_mappings', property_mappings))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if session_valid_not_on_or_after is not None:
+
+ _query_params.append(('session_valid_not_on_or_after', session_valid_not_on_or_after))
+
+ if sign_assertion is not None:
+
+ _query_params.append(('sign_assertion', sign_assertion))
+
+ if sign_logout_request is not None:
+
+ _query_params.append(('sign_logout_request', sign_logout_request))
+
+ if sign_logout_response is not None:
+
+ _query_params.append(('sign_logout_response', sign_logout_response))
+
+ if sign_response is not None:
+
+ _query_params.append(('sign_response', sign_response))
+
+ if signature_algorithm is not None:
+
+ _query_params.append(('signature_algorithm', signature_algorithm.value))
+
+ if signing_kp is not None:
+
+ _query_params.append(('signing_kp', signing_kp))
+
+ if sls_binding is not None:
+
+ _query_params.append(('sls_binding', sls_binding.value))
+
+ if sls_url is not None:
+
+ _query_params.append(('sls_url', sls_url))
+
+ if sp_binding is not None:
+
+ _query_params.append(('sp_binding', sp_binding.value))
+
+ if verification_kp is not None:
+
+ _query_params.append(('verification_kp', verification_kp))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/wsfed/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_metadata_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ download: Optional[StrictBool] = None,
+ force_binding: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> SAMLMetadata:
+ """providers_wsfed_metadata_retrieve
+
+ Return metadata as XML string
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param download:
+ :type download: bool
+ :param force_binding:
+ :type force_binding: ForceBindingEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_metadata_retrieve_serialize(
+ id=id,
+ download=download,
+ force_binding=force_binding,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLMetadata",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_metadata_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ download: Optional[StrictBool] = None,
+ force_binding: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[SAMLMetadata]:
+ """providers_wsfed_metadata_retrieve
+
+ Return metadata as XML string
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param download:
+ :type download: bool
+ :param force_binding:
+ :type force_binding: ForceBindingEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_metadata_retrieve_serialize(
+ id=id,
+ download=download,
+ force_binding=force_binding,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLMetadata",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_metadata_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ download: Optional[StrictBool] = None,
+ force_binding: Optional[Any] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_metadata_retrieve
+
+ Return metadata as XML string
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param download:
+ :type download: bool
+ :param force_binding:
+ :type force_binding: ForceBindingEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_metadata_retrieve_serialize(
+ id=id,
+ download=download,
+ force_binding=force_binding,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "SAMLMetadata",
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_metadata_retrieve_serialize(
+ self,
+ id,
+ download,
+ force_binding,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if download is not None:
+
+ _query_params.append(('download', download))
+
+ if force_binding is not None:
+
+ _query_params.append(('force_binding', force_binding.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json',
+ 'application/xml'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/wsfed/{id}/metadata/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ patched_ws_federation_provider_request: Optional[PatchedWSFederationProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WSFederationProvider:
+ """providers_wsfed_partial_update
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param patched_ws_federation_provider_request:
+ :type patched_ws_federation_provider_request: PatchedWSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_partial_update_serialize(
+ id=id,
+ patched_ws_federation_provider_request=patched_ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ patched_ws_federation_provider_request: Optional[PatchedWSFederationProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WSFederationProvider]:
+ """providers_wsfed_partial_update
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param patched_ws_federation_provider_request:
+ :type patched_ws_federation_provider_request: PatchedWSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_partial_update_serialize(
+ id=id,
+ patched_ws_federation_provider_request=patched_ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ patched_ws_federation_provider_request: Optional[PatchedWSFederationProviderRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_partial_update
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param patched_ws_federation_provider_request:
+ :type patched_ws_federation_provider_request: PatchedWSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_partial_update_serialize(
+ id=id,
+ patched_ws_federation_provider_request=patched_ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_partial_update_serialize(
+ self,
+ id,
+ patched_ws_federation_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_ws_federation_provider_request is not None:
+ _body_params = patched_ws_federation_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/providers/wsfed/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_preview_user_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PropertyMappingPreview:
+ """providers_wsfed_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_preview_user_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PropertyMappingPreview]:
+ """providers_wsfed_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_preview_user_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ for_user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_preview_user_retrieve
+
+ Preview user data for provider
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param for_user:
+ :type for_user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_preview_user_retrieve_serialize(
+ id=id,
+ for_user=for_user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PropertyMappingPreview",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_preview_user_retrieve_serialize(
+ self,
+ id,
+ for_user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ if for_user is not None:
+
+ _query_params.append(('for_user', for_user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/wsfed/{id}/preview_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WSFederationProvider:
+ """providers_wsfed_retrieve
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WSFederationProvider]:
+ """providers_wsfed_retrieve
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_retrieve
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/wsfed/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ ws_federation_provider_request: WSFederationProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> WSFederationProvider:
+ """providers_wsfed_update
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param ws_federation_provider_request: (required)
+ :type ws_federation_provider_request: WSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_update_serialize(
+ id=id,
+ ws_federation_provider_request=ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ ws_federation_provider_request: WSFederationProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[WSFederationProvider]:
+ """providers_wsfed_update
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param ws_federation_provider_request: (required)
+ :type ws_federation_provider_request: WSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_update_serialize(
+ id=id,
+ ws_federation_provider_request=ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ ws_federation_provider_request: WSFederationProviderRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_update
+
+ WSFederationProvider Viewset
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param ws_federation_provider_request: (required)
+ :type ws_federation_provider_request: WSFederationProviderRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_update_serialize(
+ id=id,
+ ws_federation_provider_request=ws_federation_provider_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "WSFederationProvider",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_update_serialize(
+ self,
+ id,
+ ws_federation_provider_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if ws_federation_provider_request is not None:
+ _body_params = ws_federation_provider_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/providers/wsfed/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def providers_wsfed_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """providers_wsfed_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def providers_wsfed_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """providers_wsfed_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def providers_wsfed_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this WS-Federation Provider.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """providers_wsfed_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this WS-Federation Provider. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._providers_wsfed_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _providers_wsfed_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/providers/wsfed/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/rac_api.py b/authentik_client/api/rac_api.py
new file mode 100644
index 000000000..b419f9f00
--- /dev/null
+++ b/authentik_client/api/rac_api.py
@@ -0,0 +1,3852 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.connection_token import ConnectionToken
+from authentik_client.models.connection_token_request import ConnectionTokenRequest
+from authentik_client.models.endpoint import Endpoint
+from authentik_client.models.endpoint_request import EndpointRequest
+from authentik_client.models.paginated_connection_token_list import PaginatedConnectionTokenList
+from authentik_client.models.paginated_endpoint_list import PaginatedEndpointList
+from authentik_client.models.patched_connection_token_request import PatchedConnectionTokenRequest
+from authentik_client.models.patched_endpoint_request import PatchedEndpointRequest
+from authentik_client.models.used_by import UsedBy
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class RacApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def rac_connection_tokens_destroy(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rac_connection_tokens_destroy
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_destroy_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_connection_tokens_destroy_with_http_info(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rac_connection_tokens_destroy
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_destroy_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_connection_tokens_destroy_without_preload_content(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_connection_tokens_destroy
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_destroy_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_connection_tokens_destroy_serialize(
+ self,
+ connection_token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connection_token_uuid is not None:
+ _path_params['connection_token_uuid'] = connection_token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/rac/connection_tokens/{connection_token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_connection_tokens_list(
+ self,
+ endpoint: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session__user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedConnectionTokenList:
+ """rac_connection_tokens_list
+
+ ConnectionToken Viewset
+
+ :param endpoint:
+ :type endpoint: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param session__user:
+ :type session__user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_list_serialize(
+ endpoint=endpoint,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ session__user=session__user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedConnectionTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_connection_tokens_list_with_http_info(
+ self,
+ endpoint: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session__user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedConnectionTokenList]:
+ """rac_connection_tokens_list
+
+ ConnectionToken Viewset
+
+ :param endpoint:
+ :type endpoint: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param session__user:
+ :type session__user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_list_serialize(
+ endpoint=endpoint,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ session__user=session__user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedConnectionTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_connection_tokens_list_without_preload_content(
+ self,
+ endpoint: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ session__user: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_connection_tokens_list
+
+ ConnectionToken Viewset
+
+ :param endpoint:
+ :type endpoint: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param session__user:
+ :type session__user: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_list_serialize(
+ endpoint=endpoint,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ session__user=session__user,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedConnectionTokenList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_connection_tokens_list_serialize(
+ self,
+ endpoint,
+ ordering,
+ page,
+ page_size,
+ provider,
+ search,
+ session__user,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if endpoint is not None:
+
+ _query_params.append(('endpoint', endpoint))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider is not None:
+
+ _query_params.append(('provider', provider))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if session__user is not None:
+
+ _query_params.append(('session__user', session__user))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rac/connection_tokens/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_connection_tokens_partial_update(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ patched_connection_token_request: Optional[PatchedConnectionTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ConnectionToken:
+ """rac_connection_tokens_partial_update
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param patched_connection_token_request:
+ :type patched_connection_token_request: PatchedConnectionTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_partial_update_serialize(
+ connection_token_uuid=connection_token_uuid,
+ patched_connection_token_request=patched_connection_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_connection_tokens_partial_update_with_http_info(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ patched_connection_token_request: Optional[PatchedConnectionTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ConnectionToken]:
+ """rac_connection_tokens_partial_update
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param patched_connection_token_request:
+ :type patched_connection_token_request: PatchedConnectionTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_partial_update_serialize(
+ connection_token_uuid=connection_token_uuid,
+ patched_connection_token_request=patched_connection_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_connection_tokens_partial_update_without_preload_content(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ patched_connection_token_request: Optional[PatchedConnectionTokenRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_connection_tokens_partial_update
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param patched_connection_token_request:
+ :type patched_connection_token_request: PatchedConnectionTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_partial_update_serialize(
+ connection_token_uuid=connection_token_uuid,
+ patched_connection_token_request=patched_connection_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_connection_tokens_partial_update_serialize(
+ self,
+ connection_token_uuid,
+ patched_connection_token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connection_token_uuid is not None:
+ _path_params['connection_token_uuid'] = connection_token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_connection_token_request is not None:
+ _body_params = patched_connection_token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/rac/connection_tokens/{connection_token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_connection_tokens_retrieve(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ConnectionToken:
+ """rac_connection_tokens_retrieve
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_retrieve_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_connection_tokens_retrieve_with_http_info(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ConnectionToken]:
+ """rac_connection_tokens_retrieve
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_retrieve_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_connection_tokens_retrieve_without_preload_content(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_connection_tokens_retrieve
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_retrieve_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_connection_tokens_retrieve_serialize(
+ self,
+ connection_token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connection_token_uuid is not None:
+ _path_params['connection_token_uuid'] = connection_token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rac/connection_tokens/{connection_token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_connection_tokens_update(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ connection_token_request: ConnectionTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ConnectionToken:
+ """rac_connection_tokens_update
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param connection_token_request: (required)
+ :type connection_token_request: ConnectionTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_update_serialize(
+ connection_token_uuid=connection_token_uuid,
+ connection_token_request=connection_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_connection_tokens_update_with_http_info(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ connection_token_request: ConnectionTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[ConnectionToken]:
+ """rac_connection_tokens_update
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param connection_token_request: (required)
+ :type connection_token_request: ConnectionTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_update_serialize(
+ connection_token_uuid=connection_token_uuid,
+ connection_token_request=connection_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_connection_tokens_update_without_preload_content(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ connection_token_request: ConnectionTokenRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_connection_tokens_update
+
+ ConnectionToken Viewset
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param connection_token_request: (required)
+ :type connection_token_request: ConnectionTokenRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_update_serialize(
+ connection_token_uuid=connection_token_uuid,
+ connection_token_request=connection_token_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "ConnectionToken",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_connection_tokens_update_serialize(
+ self,
+ connection_token_uuid,
+ connection_token_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connection_token_uuid is not None:
+ _path_params['connection_token_uuid'] = connection_token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if connection_token_request is not None:
+ _body_params = connection_token_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/rac/connection_tokens/{connection_token_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_connection_tokens_used_by_list(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """rac_connection_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_used_by_list_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_connection_tokens_used_by_list_with_http_info(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """rac_connection_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_used_by_list_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_connection_tokens_used_by_list_without_preload_content(
+ self,
+ connection_token_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Connection token.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_connection_tokens_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param connection_token_uuid: A UUID string identifying this RAC Connection token. (required)
+ :type connection_token_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_connection_tokens_used_by_list_serialize(
+ connection_token_uuid=connection_token_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_connection_tokens_used_by_list_serialize(
+ self,
+ connection_token_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if connection_token_uuid is not None:
+ _path_params['connection_token_uuid'] = connection_token_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rac/connection_tokens/{connection_token_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_create(
+ self,
+ endpoint_request: EndpointRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Endpoint:
+ """rac_endpoints_create
+
+ Endpoint Viewset
+
+ :param endpoint_request: (required)
+ :type endpoint_request: EndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_create_serialize(
+ endpoint_request=endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_create_with_http_info(
+ self,
+ endpoint_request: EndpointRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Endpoint]:
+ """rac_endpoints_create
+
+ Endpoint Viewset
+
+ :param endpoint_request: (required)
+ :type endpoint_request: EndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_create_serialize(
+ endpoint_request=endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_create_without_preload_content(
+ self,
+ endpoint_request: EndpointRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_create
+
+ Endpoint Viewset
+
+ :param endpoint_request: (required)
+ :type endpoint_request: EndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_create_serialize(
+ endpoint_request=endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_create_serialize(
+ self,
+ endpoint_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if endpoint_request is not None:
+ _body_params = endpoint_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/rac/endpoints/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_destroy(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rac_endpoints_destroy
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_destroy_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rac_endpoints_destroy
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_destroy_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_destroy
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_destroy_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_destroy_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/rac/endpoints/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ superuser_full_list: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedEndpointList:
+ """rac_endpoints_list
+
+ List accessible endpoints
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param superuser_full_list:
+ :type superuser_full_list: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ superuser_full_list=superuser_full_list,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEndpointList",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ superuser_full_list: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedEndpointList]:
+ """rac_endpoints_list
+
+ List accessible endpoints
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param superuser_full_list:
+ :type superuser_full_list: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ superuser_full_list=superuser_full_list,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEndpointList",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ provider: Optional[StrictInt] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ superuser_full_list: Optional[StrictBool] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_list
+
+ List accessible endpoints
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param provider:
+ :type provider: int
+ :param search: A search term.
+ :type search: str
+ :param superuser_full_list:
+ :type superuser_full_list: bool
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ provider=provider,
+ search=search,
+ superuser_full_list=superuser_full_list,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedEndpointList",
+ '400': None,
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ provider,
+ search,
+ superuser_full_list,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if provider is not None:
+
+ _query_params.append(('provider', provider))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if superuser_full_list is not None:
+
+ _query_params.append(('superuser_full_list', superuser_full_list))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rac/endpoints/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_partial_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ patched_endpoint_request: Optional[PatchedEndpointRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Endpoint:
+ """rac_endpoints_partial_update
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param patched_endpoint_request:
+ :type patched_endpoint_request: PatchedEndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_endpoint_request=patched_endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_partial_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ patched_endpoint_request: Optional[PatchedEndpointRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Endpoint]:
+ """rac_endpoints_partial_update
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param patched_endpoint_request:
+ :type patched_endpoint_request: PatchedEndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_endpoint_request=patched_endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_partial_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ patched_endpoint_request: Optional[PatchedEndpointRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_partial_update
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param patched_endpoint_request:
+ :type patched_endpoint_request: PatchedEndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_partial_update_serialize(
+ pbm_uuid=pbm_uuid,
+ patched_endpoint_request=patched_endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_partial_update_serialize(
+ self,
+ pbm_uuid,
+ patched_endpoint_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_endpoint_request is not None:
+ _body_params = patched_endpoint_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/rac/endpoints/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_retrieve(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Endpoint:
+ """rac_endpoints_retrieve
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_retrieve_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Endpoint]:
+ """rac_endpoints_retrieve
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_retrieve_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_retrieve
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_retrieve_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_retrieve_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rac/endpoints/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_update(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ endpoint_request: EndpointRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Endpoint:
+ """rac_endpoints_update
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param endpoint_request: (required)
+ :type endpoint_request: EndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_update_serialize(
+ pbm_uuid=pbm_uuid,
+ endpoint_request=endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_update_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ endpoint_request: EndpointRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Endpoint]:
+ """rac_endpoints_update
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param endpoint_request: (required)
+ :type endpoint_request: EndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_update_serialize(
+ pbm_uuid=pbm_uuid,
+ endpoint_request=endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_update_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ endpoint_request: EndpointRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_update
+
+ Endpoint Viewset
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param endpoint_request: (required)
+ :type endpoint_request: EndpointRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_update_serialize(
+ pbm_uuid=pbm_uuid,
+ endpoint_request=endpoint_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Endpoint",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_update_serialize(
+ self,
+ pbm_uuid,
+ endpoint_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if endpoint_request is not None:
+ _body_params = endpoint_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/rac/endpoints/{pbm_uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rac_endpoints_used_by_list(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """rac_endpoints_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rac_endpoints_used_by_list_with_http_info(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """rac_endpoints_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rac_endpoints_used_by_list_without_preload_content(
+ self,
+ pbm_uuid: Annotated[UUID, Field(description="A UUID string identifying this RAC Endpoint.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rac_endpoints_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param pbm_uuid: A UUID string identifying this RAC Endpoint. (required)
+ :type pbm_uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rac_endpoints_used_by_list_serialize(
+ pbm_uuid=pbm_uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rac_endpoints_used_by_list_serialize(
+ self,
+ pbm_uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if pbm_uuid is not None:
+ _path_params['pbm_uuid'] = pbm_uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rac/endpoints/{pbm_uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/rbac_api.py b/authentik_client/api/rbac_api.py
new file mode 100644
index 000000000..d55de8abf
--- /dev/null
+++ b/authentik_client/api/rbac_api.py
@@ -0,0 +1,6690 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.initial_permissions import InitialPermissions
+from authentik_client.models.initial_permissions_request import InitialPermissionsRequest
+from authentik_client.models.paginated_extra_role_object_permission_list import PaginatedExtraRoleObjectPermissionList
+from authentik_client.models.paginated_initial_permissions_list import PaginatedInitialPermissionsList
+from authentik_client.models.paginated_permission_list import PaginatedPermissionList
+from authentik_client.models.paginated_role_assigned_object_permission_list import PaginatedRoleAssignedObjectPermissionList
+from authentik_client.models.paginated_role_list import PaginatedRoleList
+from authentik_client.models.patched_initial_permissions_request import PatchedInitialPermissionsRequest
+from authentik_client.models.patched_permission_assign_request import PatchedPermissionAssignRequest
+from authentik_client.models.patched_role_request import PatchedRoleRequest
+from authentik_client.models.permission import Permission
+from authentik_client.models.permission_assign_request import PermissionAssignRequest
+from authentik_client.models.permission_assign_result import PermissionAssignResult
+from authentik_client.models.role import Role
+from authentik_client.models.role_request import RoleRequest
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.user_account_serializer_for_role_request import UserAccountSerializerForRoleRequest
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class RbacApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def rbac_initial_permissions_create(
+ self,
+ initial_permissions_request: InitialPermissionsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> InitialPermissions:
+ """rbac_initial_permissions_create
+
+ InitialPermissions viewset
+
+ :param initial_permissions_request: (required)
+ :type initial_permissions_request: InitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_create_serialize(
+ initial_permissions_request=initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_create_with_http_info(
+ self,
+ initial_permissions_request: InitialPermissionsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[InitialPermissions]:
+ """rbac_initial_permissions_create
+
+ InitialPermissions viewset
+
+ :param initial_permissions_request: (required)
+ :type initial_permissions_request: InitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_create_serialize(
+ initial_permissions_request=initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_create_without_preload_content(
+ self,
+ initial_permissions_request: InitialPermissionsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_create
+
+ InitialPermissions viewset
+
+ :param initial_permissions_request: (required)
+ :type initial_permissions_request: InitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_create_serialize(
+ initial_permissions_request=initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_create_serialize(
+ self,
+ initial_permissions_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if initial_permissions_request is not None:
+ _body_params = initial_permissions_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/rbac/initial_permissions/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_initial_permissions_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rbac_initial_permissions_destroy
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rbac_initial_permissions_destroy
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_destroy
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/rbac/initial_permissions/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_initial_permissions_list(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedInitialPermissionsList:
+ """rbac_initial_permissions_list
+
+ InitialPermissions viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedInitialPermissionsList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_list_with_http_info(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedInitialPermissionsList]:
+ """rbac_initial_permissions_list
+
+ InitialPermissions viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedInitialPermissionsList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_list_without_preload_content(
+ self,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_list
+
+ InitialPermissions viewset
+
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_list_serialize(
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedInitialPermissionsList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_list_serialize(
+ self,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/initial_permissions/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_initial_permissions_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ patched_initial_permissions_request: Optional[PatchedInitialPermissionsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> InitialPermissions:
+ """rbac_initial_permissions_partial_update
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param patched_initial_permissions_request:
+ :type patched_initial_permissions_request: PatchedInitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_partial_update_serialize(
+ id=id,
+ patched_initial_permissions_request=patched_initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ patched_initial_permissions_request: Optional[PatchedInitialPermissionsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[InitialPermissions]:
+ """rbac_initial_permissions_partial_update
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param patched_initial_permissions_request:
+ :type patched_initial_permissions_request: PatchedInitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_partial_update_serialize(
+ id=id,
+ patched_initial_permissions_request=patched_initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ patched_initial_permissions_request: Optional[PatchedInitialPermissionsRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_partial_update
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param patched_initial_permissions_request:
+ :type patched_initial_permissions_request: PatchedInitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_partial_update_serialize(
+ id=id,
+ patched_initial_permissions_request=patched_initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_partial_update_serialize(
+ self,
+ id,
+ patched_initial_permissions_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_initial_permissions_request is not None:
+ _body_params = patched_initial_permissions_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/rbac/initial_permissions/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_initial_permissions_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> InitialPermissions:
+ """rbac_initial_permissions_retrieve
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[InitialPermissions]:
+ """rbac_initial_permissions_retrieve
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_retrieve
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/initial_permissions/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_initial_permissions_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ initial_permissions_request: InitialPermissionsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> InitialPermissions:
+ """rbac_initial_permissions_update
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param initial_permissions_request: (required)
+ :type initial_permissions_request: InitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_update_serialize(
+ id=id,
+ initial_permissions_request=initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ initial_permissions_request: InitialPermissionsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[InitialPermissions]:
+ """rbac_initial_permissions_update
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param initial_permissions_request: (required)
+ :type initial_permissions_request: InitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_update_serialize(
+ id=id,
+ initial_permissions_request=initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ initial_permissions_request: InitialPermissionsRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_update
+
+ InitialPermissions viewset
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param initial_permissions_request: (required)
+ :type initial_permissions_request: InitialPermissionsRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_update_serialize(
+ id=id,
+ initial_permissions_request=initial_permissions_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "InitialPermissions",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_update_serialize(
+ self,
+ id,
+ initial_permissions_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if initial_permissions_request is not None:
+ _body_params = initial_permissions_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/rbac/initial_permissions/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_initial_permissions_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """rbac_initial_permissions_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_initial_permissions_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """rbac_initial_permissions_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_initial_permissions_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Initial Permissions.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_initial_permissions_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Initial Permissions. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_initial_permissions_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_initial_permissions_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/initial_permissions/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_assign(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ permission_assign_request: PermissionAssignRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[PermissionAssignResult]:
+ """rbac_permissions_assigned_by_roles_assign
+
+ Assign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param permission_assign_request: (required)
+ :type permission_assign_request: PermissionAssignRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_assign_serialize(
+ uuid=uuid,
+ permission_assign_request=permission_assign_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[PermissionAssignResult]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_assign_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ permission_assign_request: PermissionAssignRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[PermissionAssignResult]]:
+ """rbac_permissions_assigned_by_roles_assign
+
+ Assign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param permission_assign_request: (required)
+ :type permission_assign_request: PermissionAssignRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_assign_serialize(
+ uuid=uuid,
+ permission_assign_request=permission_assign_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[PermissionAssignResult]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_assign_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ permission_assign_request: PermissionAssignRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_permissions_assigned_by_roles_assign
+
+ Assign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param permission_assign_request: (required)
+ :type permission_assign_request: PermissionAssignRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_assign_serialize(
+ uuid=uuid,
+ permission_assign_request=permission_assign_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[PermissionAssignResult]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_permissions_assigned_by_roles_assign_serialize(
+ self,
+ uuid,
+ permission_assign_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if permission_assign_request is not None:
+ _body_params = permission_assign_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/rbac/permissions/assigned_by_roles/{uuid}/assign/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_list(
+ self,
+ model: StrictStr,
+ object_pk: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRoleAssignedObjectPermissionList:
+ """rbac_permissions_assigned_by_roles_list
+
+ Get assigned object permissions for a single object
+
+ :param model: (required)
+ :type model: str
+ :param object_pk:
+ :type object_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_list_serialize(
+ model=model,
+ object_pk=object_pk,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRoleAssignedObjectPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_list_with_http_info(
+ self,
+ model: StrictStr,
+ object_pk: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRoleAssignedObjectPermissionList]:
+ """rbac_permissions_assigned_by_roles_list
+
+ Get assigned object permissions for a single object
+
+ :param model: (required)
+ :type model: str
+ :param object_pk:
+ :type object_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_list_serialize(
+ model=model,
+ object_pk=object_pk,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRoleAssignedObjectPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_list_without_preload_content(
+ self,
+ model: StrictStr,
+ object_pk: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_permissions_assigned_by_roles_list
+
+ Get assigned object permissions for a single object
+
+ :param model: (required)
+ :type model: str
+ :param object_pk:
+ :type object_pk: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_list_serialize(
+ model=model,
+ object_pk=object_pk,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRoleAssignedObjectPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_permissions_assigned_by_roles_list_serialize(
+ self,
+ model,
+ object_pk,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if model is not None:
+
+ _query_params.append(('model', model))
+
+ if object_pk is not None:
+
+ _query_params.append(('object_pk', object_pk))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/permissions/assigned_by_roles/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_unassign_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ patched_permission_assign_request: Optional[PatchedPermissionAssignRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rbac_permissions_assigned_by_roles_unassign_partial_update
+
+ Unassign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param patched_permission_assign_request:
+ :type patched_permission_assign_request: PatchedPermissionAssignRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_unassign_partial_update_serialize(
+ uuid=uuid,
+ patched_permission_assign_request=patched_permission_assign_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_unassign_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ patched_permission_assign_request: Optional[PatchedPermissionAssignRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rbac_permissions_assigned_by_roles_unassign_partial_update
+
+ Unassign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param patched_permission_assign_request:
+ :type patched_permission_assign_request: PatchedPermissionAssignRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_unassign_partial_update_serialize(
+ uuid=uuid,
+ patched_permission_assign_request=patched_permission_assign_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_permissions_assigned_by_roles_unassign_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ patched_permission_assign_request: Optional[PatchedPermissionAssignRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_permissions_assigned_by_roles_unassign_partial_update
+
+ Unassign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param patched_permission_assign_request:
+ :type patched_permission_assign_request: PatchedPermissionAssignRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_assigned_by_roles_unassign_partial_update_serialize(
+ uuid=uuid,
+ patched_permission_assign_request=patched_permission_assign_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_permissions_assigned_by_roles_unassign_partial_update_serialize(
+ self,
+ uuid,
+ patched_permission_assign_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_permission_assign_request is not None:
+ _body_params = patched_permission_assign_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/rbac/permissions/assigned_by_roles/{uuid}/unassign/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_permissions_list(
+ self,
+ codename: Optional[StrictStr] = None,
+ content_type__app_label: Optional[StrictStr] = None,
+ content_type__model: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ role: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedPermissionList:
+ """rbac_permissions_list
+
+ Read-only list of all permissions, filterable by model and app
+
+ :param codename:
+ :type codename: str
+ :param content_type__app_label:
+ :type content_type__app_label: str
+ :param content_type__model:
+ :type content_type__model: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param role:
+ :type role: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_list_serialize(
+ codename=codename,
+ content_type__app_label=content_type__app_label,
+ content_type__model=content_type__model,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ role=role,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_permissions_list_with_http_info(
+ self,
+ codename: Optional[StrictStr] = None,
+ content_type__app_label: Optional[StrictStr] = None,
+ content_type__model: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ role: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedPermissionList]:
+ """rbac_permissions_list
+
+ Read-only list of all permissions, filterable by model and app
+
+ :param codename:
+ :type codename: str
+ :param content_type__app_label:
+ :type content_type__app_label: str
+ :param content_type__model:
+ :type content_type__model: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param role:
+ :type role: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_list_serialize(
+ codename=codename,
+ content_type__app_label=content_type__app_label,
+ content_type__model=content_type__model,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ role=role,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_permissions_list_without_preload_content(
+ self,
+ codename: Optional[StrictStr] = None,
+ content_type__app_label: Optional[StrictStr] = None,
+ content_type__model: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ role: Optional[StrictStr] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_permissions_list
+
+ Read-only list of all permissions, filterable by model and app
+
+ :param codename:
+ :type codename: str
+ :param content_type__app_label:
+ :type content_type__app_label: str
+ :param content_type__model:
+ :type content_type__model: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param role:
+ :type role: str
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_list_serialize(
+ codename=codename,
+ content_type__app_label=content_type__app_label,
+ content_type__model=content_type__model,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ role=role,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_permissions_list_serialize(
+ self,
+ codename,
+ content_type__app_label,
+ content_type__model,
+ ordering,
+ page,
+ page_size,
+ role,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if codename is not None:
+
+ _query_params.append(('codename', codename))
+
+ if content_type__app_label is not None:
+
+ _query_params.append(('content_type__app_label', content_type__app_label))
+
+ if content_type__model is not None:
+
+ _query_params.append(('content_type__model', content_type__model))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if role is not None:
+
+ _query_params.append(('role', role))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/permissions/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_permissions_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this permission.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Permission:
+ """rbac_permissions_retrieve
+
+ Read-only list of all permissions, filterable by model and app
+
+ :param id: A unique integer value identifying this permission. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Permission",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_permissions_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this permission.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Permission]:
+ """rbac_permissions_retrieve
+
+ Read-only list of all permissions, filterable by model and app
+
+ :param id: A unique integer value identifying this permission. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Permission",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_permissions_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this permission.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_permissions_retrieve
+
+ Read-only list of all permissions, filterable by model and app
+
+ :param id: A unique integer value identifying this permission. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Permission",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_permissions_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/permissions/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_permissions_roles_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedExtraRoleObjectPermissionList:
+ """rbac_permissions_roles_list
+
+ Get a role's assigned object permissions
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_roles_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExtraRoleObjectPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_permissions_roles_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedExtraRoleObjectPermissionList]:
+ """rbac_permissions_roles_list
+
+ Get a role's assigned object permissions
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_roles_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExtraRoleObjectPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_permissions_roles_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ uuid: Optional[UUID] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_permissions_roles_list
+
+ Get a role's assigned object permissions
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param uuid:
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_permissions_roles_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedExtraRoleObjectPermissionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_permissions_roles_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ search,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if uuid is not None:
+
+ _query_params.append(('uuid', uuid))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/permissions/roles/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_add_user_create(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rbac_roles_add_user_create
+
+ Add user to role
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param user_account_serializer_for_role_request: (required)
+ :type user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_add_user_create_serialize(
+ uuid=uuid,
+ user_account_serializer_for_role_request=user_account_serializer_for_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_add_user_create_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rbac_roles_add_user_create
+
+ Add user to role
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param user_account_serializer_for_role_request: (required)
+ :type user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_add_user_create_serialize(
+ uuid=uuid,
+ user_account_serializer_for_role_request=user_account_serializer_for_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_add_user_create_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_add_user_create
+
+ Add user to role
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param user_account_serializer_for_role_request: (required)
+ :type user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_add_user_create_serialize(
+ uuid=uuid,
+ user_account_serializer_for_role_request=user_account_serializer_for_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_add_user_create_serialize(
+ self,
+ uuid,
+ user_account_serializer_for_role_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_account_serializer_for_role_request is not None:
+ _body_params = user_account_serializer_for_role_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/rbac/roles/{uuid}/add_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_create(
+ self,
+ role_request: RoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Role:
+ """rbac_roles_create
+
+ Role viewset
+
+ :param role_request: (required)
+ :type role_request: RoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_create_serialize(
+ role_request=role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_create_with_http_info(
+ self,
+ role_request: RoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Role]:
+ """rbac_roles_create
+
+ Role viewset
+
+ :param role_request: (required)
+ :type role_request: RoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_create_serialize(
+ role_request=role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_create_without_preload_content(
+ self,
+ role_request: RoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_create
+
+ Role viewset
+
+ :param role_request: (required)
+ :type role_request: RoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_create_serialize(
+ role_request=role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_create_serialize(
+ self,
+ role_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if role_request is not None:
+ _body_params = role_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/rbac/roles/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_destroy(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rbac_roles_destroy
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_destroy_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rbac_roles_destroy
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_destroy_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_destroy
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_destroy_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_destroy_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/rbac/roles/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_list(
+ self,
+ groups: Optional[UUID] = None,
+ inherited: Annotated[Optional[StrictBool], Field(description="Include inherited roles (requires users or groups filter)")] = None,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ users: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedRoleList:
+ """rbac_roles_list
+
+ Role viewset
+
+ :param groups:
+ :type groups: UUID
+ :param inherited: Include inherited roles (requires users or groups filter)
+ :type inherited: bool
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param users:
+ :type users: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_list_serialize(
+ groups=groups,
+ inherited=inherited,
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ users=users,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRoleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_list_with_http_info(
+ self,
+ groups: Optional[UUID] = None,
+ inherited: Annotated[Optional[StrictBool], Field(description="Include inherited roles (requires users or groups filter)")] = None,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ users: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedRoleList]:
+ """rbac_roles_list
+
+ Role viewset
+
+ :param groups:
+ :type groups: UUID
+ :param inherited: Include inherited roles (requires users or groups filter)
+ :type inherited: bool
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param users:
+ :type users: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_list_serialize(
+ groups=groups,
+ inherited=inherited,
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ users=users,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRoleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_list_without_preload_content(
+ self,
+ groups: Optional[UUID] = None,
+ inherited: Annotated[Optional[StrictBool], Field(description="Include inherited roles (requires users or groups filter)")] = None,
+ managed: Optional[List[StrictStr]] = None,
+ managed__isnull: Optional[StrictBool] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ users: Optional[StrictInt] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_list
+
+ Role viewset
+
+ :param groups:
+ :type groups: UUID
+ :param inherited: Include inherited roles (requires users or groups filter)
+ :type inherited: bool
+ :param managed:
+ :type managed: List[str]
+ :param managed__isnull:
+ :type managed__isnull: bool
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param users:
+ :type users: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_list_serialize(
+ groups=groups,
+ inherited=inherited,
+ managed=managed,
+ managed__isnull=managed__isnull,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ users=users,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedRoleList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_list_serialize(
+ self,
+ groups,
+ inherited,
+ managed,
+ managed__isnull,
+ name,
+ ordering,
+ page,
+ page_size,
+ search,
+ users,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ 'managed': 'multi',
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if groups is not None:
+
+ _query_params.append(('groups', groups))
+
+ if inherited is not None:
+
+ _query_params.append(('inherited', inherited))
+
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if managed__isnull is not None:
+
+ _query_params.append(('managed__isnull', managed__isnull))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if users is not None:
+
+ _query_params.append(('users', users))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/roles/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_partial_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ patched_role_request: Optional[PatchedRoleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Role:
+ """rbac_roles_partial_update
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param patched_role_request:
+ :type patched_role_request: PatchedRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_partial_update_serialize(
+ uuid=uuid,
+ patched_role_request=patched_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_partial_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ patched_role_request: Optional[PatchedRoleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Role]:
+ """rbac_roles_partial_update
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param patched_role_request:
+ :type patched_role_request: PatchedRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_partial_update_serialize(
+ uuid=uuid,
+ patched_role_request=patched_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_partial_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ patched_role_request: Optional[PatchedRoleRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_partial_update
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param patched_role_request:
+ :type patched_role_request: PatchedRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_partial_update_serialize(
+ uuid=uuid,
+ patched_role_request=patched_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_partial_update_serialize(
+ self,
+ uuid,
+ patched_role_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_role_request is not None:
+ _body_params = patched_role_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/rbac/roles/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_remove_user_create(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """rbac_roles_remove_user_create
+
+ Remove user from role
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param user_account_serializer_for_role_request: (required)
+ :type user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_remove_user_create_serialize(
+ uuid=uuid,
+ user_account_serializer_for_role_request=user_account_serializer_for_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_remove_user_create_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """rbac_roles_remove_user_create
+
+ Remove user from role
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param user_account_serializer_for_role_request: (required)
+ :type user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_remove_user_create_serialize(
+ uuid=uuid,
+ user_account_serializer_for_role_request=user_account_serializer_for_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_remove_user_create_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_remove_user_create
+
+ Remove user from role
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param user_account_serializer_for_role_request: (required)
+ :type user_account_serializer_for_role_request: UserAccountSerializerForRoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_remove_user_create_serialize(
+ uuid=uuid,
+ user_account_serializer_for_role_request=user_account_serializer_for_role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '404': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_remove_user_create_serialize(
+ self,
+ uuid,
+ user_account_serializer_for_role_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if user_account_serializer_for_role_request is not None:
+ _body_params = user_account_serializer_for_role_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/rbac/roles/{uuid}/remove_user/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_retrieve(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Role:
+ """rbac_roles_retrieve
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_retrieve_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Role]:
+ """rbac_roles_retrieve
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_retrieve_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_retrieve
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_retrieve_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_retrieve_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/roles/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_update(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ role_request: RoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Role:
+ """rbac_roles_update
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param role_request: (required)
+ :type role_request: RoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_update_serialize(
+ uuid=uuid,
+ role_request=role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_update_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ role_request: RoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Role]:
+ """rbac_roles_update
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param role_request: (required)
+ :type role_request: RoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_update_serialize(
+ uuid=uuid,
+ role_request=role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_update_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ role_request: RoleRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_update
+
+ Role viewset
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param role_request: (required)
+ :type role_request: RoleRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_update_serialize(
+ uuid=uuid,
+ role_request=role_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Role",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_update_serialize(
+ self,
+ uuid,
+ role_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if role_request is not None:
+ _body_params = role_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/rbac/roles/{uuid}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def rbac_roles_used_by_list(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """rbac_roles_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def rbac_roles_used_by_list_with_http_info(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """rbac_roles_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def rbac_roles_used_by_list_without_preload_content(
+ self,
+ uuid: Annotated[UUID, Field(description="A UUID string identifying this Role.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """rbac_roles_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param uuid: A UUID string identifying this Role. (required)
+ :type uuid: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._rbac_roles_used_by_list_serialize(
+ uuid=uuid,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _rbac_roles_used_by_list_serialize(
+ self,
+ uuid,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if uuid is not None:
+ _path_params['uuid'] = uuid
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/rbac/roles/{uuid}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/reports_api.py b/authentik_client/api/reports_api.py
new file mode 100644
index 000000000..697f06434
--- /dev/null
+++ b/authentik_client/api/reports_api.py
@@ -0,0 +1,886 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.data_export import DataExport
+from authentik_client.models.paginated_data_export_list import PaginatedDataExportList
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class ReportsApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def reports_exports_destroy(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Data Export.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """reports_exports_destroy
+
+
+ :param id: A UUID string identifying this Data Export. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def reports_exports_destroy_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Data Export.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """reports_exports_destroy
+
+
+ :param id: A UUID string identifying this Data Export. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def reports_exports_destroy_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Data Export.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """reports_exports_destroy
+
+
+ :param id: A UUID string identifying this Data Export. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _reports_exports_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/reports/exports/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def reports_exports_list(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedDataExportList:
+ """reports_exports_list
+
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDataExportList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def reports_exports_list_with_http_info(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedDataExportList]:
+ """reports_exports_list
+
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDataExportList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def reports_exports_list_without_preload_content(
+ self,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """reports_exports_list
+
+
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_list_serialize(
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedDataExportList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _reports_exports_list_serialize(
+ self,
+ ordering,
+ page,
+ page_size,
+ search,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/reports/exports/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def reports_exports_retrieve(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Data Export.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> DataExport:
+ """reports_exports_retrieve
+
+
+ :param id: A UUID string identifying this Data Export. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def reports_exports_retrieve_with_http_info(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Data Export.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[DataExport]:
+ """reports_exports_retrieve
+
+
+ :param id: A UUID string identifying this Data Export. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def reports_exports_retrieve_without_preload_content(
+ self,
+ id: Annotated[UUID, Field(description="A UUID string identifying this Data Export.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """reports_exports_retrieve
+
+
+ :param id: A UUID string identifying this Data Export. (required)
+ :type id: UUID
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._reports_exports_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "DataExport",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _reports_exports_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/reports/exports/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/root_api.py b/authentik_client/api/root_api.py
new file mode 100644
index 000000000..ff242aac8
--- /dev/null
+++ b/authentik_client/api/root_api.py
@@ -0,0 +1,288 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from authentik_client.models.config import Config
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class RootApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def root_config_retrieve(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Config:
+ """root_config_retrieve
+
+ Retrieve public configuration options
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._root_config_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Config",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def root_config_retrieve_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Config]:
+ """root_config_retrieve
+
+ Retrieve public configuration options
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._root_config_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Config",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def root_config_retrieve_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """root_config_retrieve
+
+ Retrieve public configuration options
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._root_config_retrieve_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Config",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _root_config_retrieve_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/root/config/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/schema_api.py b/authentik_client/api/schema_api.py
new file mode 100644
index 000000000..f2abe749a
--- /dev/null
+++ b/authentik_client/api/schema_api.py
@@ -0,0 +1,327 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from typing import Any, Dict, Optional
+from authentik_client.models.format_enum import FormatEnum
+from authentik_client.models.lang_enum import LangEnum
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class SchemaApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def schema_retrieve(
+ self,
+ format: Optional[FormatEnum] = None,
+ lang: Optional[LangEnum] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Dict[str, object]:
+ """schema_retrieve
+
+ OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+ :param format:
+ :type format: FormatEnum
+ :param lang:
+ :type lang: LangEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._schema_retrieve_serialize(
+ format=format,
+ lang=lang,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Dict[str, object]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def schema_retrieve_with_http_info(
+ self,
+ format: Optional[FormatEnum] = None,
+ lang: Optional[LangEnum] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Dict[str, object]]:
+ """schema_retrieve
+
+ OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+ :param format:
+ :type format: FormatEnum
+ :param lang:
+ :type lang: LangEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._schema_retrieve_serialize(
+ format=format,
+ lang=lang,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Dict[str, object]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def schema_retrieve_without_preload_content(
+ self,
+ format: Optional[FormatEnum] = None,
+ lang: Optional[LangEnum] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """schema_retrieve
+
+ OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+ :param format:
+ :type format: FormatEnum
+ :param lang:
+ :type lang: LangEnum
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._schema_retrieve_serialize(
+ format=format,
+ lang=lang,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Dict[str, object]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _schema_retrieve_serialize(
+ self,
+ format,
+ lang,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if format is not None:
+
+ _query_params.append(('format', format.value))
+
+ if lang is not None:
+
+ _query_params.append(('lang', lang.value))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/vnd.oai.openapi',
+ 'application/yaml',
+ 'application/vnd.oai.openapi+json',
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/schema/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
diff --git a/authentik_client/api/sources_api.py b/authentik_client/api/sources_api.py
new file mode 100644
index 000000000..0c660245a
--- /dev/null
+++ b/authentik_client/api/sources_api.py
@@ -0,0 +1,51640 @@
+"""
+ authentik
+
+ Making authentication simple.
+
+ The version of the OpenAPI document: 2026.5.0-rc1
+ Contact: hello@goauthentik.io
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+ Do not edit the class manually.
+""" # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import Any, List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.binding_type_enum import BindingTypeEnum
+from authentik_client.models.digest_algorithm_enum import DigestAlgorithmEnum
+from authentik_client.models.group_kerberos_source_connection import GroupKerberosSourceConnection
+from authentik_client.models.group_kerberos_source_connection_request import GroupKerberosSourceConnectionRequest
+from authentik_client.models.group_ldap_source_connection import GroupLDAPSourceConnection
+from authentik_client.models.group_ldap_source_connection_request import GroupLDAPSourceConnectionRequest
+from authentik_client.models.group_o_auth_source_connection import GroupOAuthSourceConnection
+from authentik_client.models.group_o_auth_source_connection_request import GroupOAuthSourceConnectionRequest
+from authentik_client.models.group_plex_source_connection import GroupPlexSourceConnection
+from authentik_client.models.group_plex_source_connection_request import GroupPlexSourceConnectionRequest
+from authentik_client.models.group_saml_source_connection import GroupSAMLSourceConnection
+from authentik_client.models.group_saml_source_connection_request import GroupSAMLSourceConnectionRequest
+from authentik_client.models.group_source_connection import GroupSourceConnection
+from authentik_client.models.group_source_connection_request import GroupSourceConnectionRequest
+from authentik_client.models.group_telegram_source_connection import GroupTelegramSourceConnection
+from authentik_client.models.group_telegram_source_connection_request import GroupTelegramSourceConnectionRequest
+from authentik_client.models.kerberos_source import KerberosSource
+from authentik_client.models.kerberos_source_request import KerberosSourceRequest
+from authentik_client.models.ldap_debug import LDAPDebug
+from authentik_client.models.ldap_source import LDAPSource
+from authentik_client.models.ldap_source_request import LDAPSourceRequest
+from authentik_client.models.o_auth_source import OAuthSource
+from authentik_client.models.o_auth_source_request import OAuthSourceRequest
+from authentik_client.models.paginated_group_kerberos_source_connection_list import PaginatedGroupKerberosSourceConnectionList
+from authentik_client.models.paginated_group_ldap_source_connection_list import PaginatedGroupLDAPSourceConnectionList
+from authentik_client.models.paginated_group_o_auth_source_connection_list import PaginatedGroupOAuthSourceConnectionList
+from authentik_client.models.paginated_group_plex_source_connection_list import PaginatedGroupPlexSourceConnectionList
+from authentik_client.models.paginated_group_saml_source_connection_list import PaginatedGroupSAMLSourceConnectionList
+from authentik_client.models.paginated_group_source_connection_list import PaginatedGroupSourceConnectionList
+from authentik_client.models.paginated_group_telegram_source_connection_list import PaginatedGroupTelegramSourceConnectionList
+from authentik_client.models.paginated_kerberos_source_list import PaginatedKerberosSourceList
+from authentik_client.models.paginated_ldap_source_list import PaginatedLDAPSourceList
+from authentik_client.models.paginated_o_auth_source_list import PaginatedOAuthSourceList
+from authentik_client.models.paginated_plex_source_list import PaginatedPlexSourceList
+from authentik_client.models.paginated_saml_source_list import PaginatedSAMLSourceList
+from authentik_client.models.paginated_scim_source_group_list import PaginatedSCIMSourceGroupList
+from authentik_client.models.paginated_scim_source_list import PaginatedSCIMSourceList
+from authentik_client.models.paginated_scim_source_user_list import PaginatedSCIMSourceUserList
+from authentik_client.models.paginated_source_list import PaginatedSourceList
+from authentik_client.models.paginated_telegram_source_list import PaginatedTelegramSourceList
+from authentik_client.models.paginated_user_kerberos_source_connection_list import PaginatedUserKerberosSourceConnectionList
+from authentik_client.models.paginated_user_ldap_source_connection_list import PaginatedUserLDAPSourceConnectionList
+from authentik_client.models.paginated_user_o_auth_source_connection_list import PaginatedUserOAuthSourceConnectionList
+from authentik_client.models.paginated_user_plex_source_connection_list import PaginatedUserPlexSourceConnectionList
+from authentik_client.models.paginated_user_saml_source_connection_list import PaginatedUserSAMLSourceConnectionList
+from authentik_client.models.paginated_user_source_connection_list import PaginatedUserSourceConnectionList
+from authentik_client.models.paginated_user_telegram_source_connection_list import PaginatedUserTelegramSourceConnectionList
+from authentik_client.models.patched_group_kerberos_source_connection_request import PatchedGroupKerberosSourceConnectionRequest
+from authentik_client.models.patched_group_ldap_source_connection_request import PatchedGroupLDAPSourceConnectionRequest
+from authentik_client.models.patched_group_o_auth_source_connection_request import PatchedGroupOAuthSourceConnectionRequest
+from authentik_client.models.patched_group_plex_source_connection_request import PatchedGroupPlexSourceConnectionRequest
+from authentik_client.models.patched_group_saml_source_connection_request import PatchedGroupSAMLSourceConnectionRequest
+from authentik_client.models.patched_group_source_connection_request import PatchedGroupSourceConnectionRequest
+from authentik_client.models.patched_group_telegram_source_connection_request import PatchedGroupTelegramSourceConnectionRequest
+from authentik_client.models.patched_kerberos_source_request import PatchedKerberosSourceRequest
+from authentik_client.models.patched_ldap_source_request import PatchedLDAPSourceRequest
+from authentik_client.models.patched_o_auth_source_request import PatchedOAuthSourceRequest
+from authentik_client.models.patched_plex_source_request import PatchedPlexSourceRequest
+from authentik_client.models.patched_saml_source_request import PatchedSAMLSourceRequest
+from authentik_client.models.patched_scim_source_group_request import PatchedSCIMSourceGroupRequest
+from authentik_client.models.patched_scim_source_request import PatchedSCIMSourceRequest
+from authentik_client.models.patched_scim_source_user_request import PatchedSCIMSourceUserRequest
+from authentik_client.models.patched_telegram_source_request import PatchedTelegramSourceRequest
+from authentik_client.models.patched_user_kerberos_source_connection_request import PatchedUserKerberosSourceConnectionRequest
+from authentik_client.models.patched_user_ldap_source_connection_request import PatchedUserLDAPSourceConnectionRequest
+from authentik_client.models.patched_user_o_auth_source_connection_request import PatchedUserOAuthSourceConnectionRequest
+from authentik_client.models.patched_user_plex_source_connection_request import PatchedUserPlexSourceConnectionRequest
+from authentik_client.models.patched_user_saml_source_connection_request import PatchedUserSAMLSourceConnectionRequest
+from authentik_client.models.patched_user_source_connection_request import PatchedUserSourceConnectionRequest
+from authentik_client.models.patched_user_telegram_source_connection_request import PatchedUserTelegramSourceConnectionRequest
+from authentik_client.models.plex_source import PlexSource
+from authentik_client.models.plex_source_request import PlexSourceRequest
+from authentik_client.models.plex_token_redeem_request import PlexTokenRedeemRequest
+from authentik_client.models.policy_engine_mode import PolicyEngineMode
+from authentik_client.models.redirect_challenge import RedirectChallenge
+from authentik_client.models.saml_metadata import SAMLMetadata
+from authentik_client.models.saml_source import SAMLSource
+from authentik_client.models.saml_source_request import SAMLSourceRequest
+from authentik_client.models.scim_source import SCIMSource
+from authentik_client.models.scim_source_group import SCIMSourceGroup
+from authentik_client.models.scim_source_group_request import SCIMSourceGroupRequest
+from authentik_client.models.scim_source_request import SCIMSourceRequest
+from authentik_client.models.scim_source_user import SCIMSourceUser
+from authentik_client.models.scim_source_user_request import SCIMSourceUserRequest
+from authentik_client.models.signature_algorithm_enum import SignatureAlgorithmEnum
+from authentik_client.models.source import Source
+from authentik_client.models.source_type import SourceType
+from authentik_client.models.sync_status import SyncStatus
+from authentik_client.models.telegram_auth_request import TelegramAuthRequest
+from authentik_client.models.telegram_source import TelegramSource
+from authentik_client.models.telegram_source_request import TelegramSourceRequest
+from authentik_client.models.type_create import TypeCreate
+from authentik_client.models.used_by import UsedBy
+from authentik_client.models.user_kerberos_source_connection import UserKerberosSourceConnection
+from authentik_client.models.user_kerberos_source_connection_request import UserKerberosSourceConnectionRequest
+from authentik_client.models.user_ldap_source_connection import UserLDAPSourceConnection
+from authentik_client.models.user_ldap_source_connection_request import UserLDAPSourceConnectionRequest
+from authentik_client.models.user_o_auth_source_connection import UserOAuthSourceConnection
+from authentik_client.models.user_o_auth_source_connection_request import UserOAuthSourceConnectionRequest
+from authentik_client.models.user_plex_source_connection import UserPlexSourceConnection
+from authentik_client.models.user_plex_source_connection_request import UserPlexSourceConnectionRequest
+from authentik_client.models.user_saml_source_connection import UserSAMLSourceConnection
+from authentik_client.models.user_saml_source_connection_request import UserSAMLSourceConnectionRequest
+from authentik_client.models.user_setting import UserSetting
+from authentik_client.models.user_source_connection import UserSourceConnection
+from authentik_client.models.user_source_connection_request import UserSourceConnectionRequest
+from authentik_client.models.user_telegram_source_connection import UserTelegramSourceConnection
+from authentik_client.models.user_telegram_source_connection_request import UserTelegramSourceConnectionRequest
+
+from authentik_client.api_client import ApiClient, RequestSerialized
+from authentik_client.api_response import ApiResponse
+from authentik_client.rest import RESTResponseType
+
+
+class SourcesApi:
+ """NOTE: This class is auto generated by OpenAPI Generator
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ def __init__(self, api_client=None) -> None:
+ if api_client is None:
+ api_client = ApiClient.get_default()
+ self.api_client = api_client
+
+
+ @validate_call
+ def sources_all_destroy(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """sources_all_destroy
+
+ Prevent deletion of built-in sources
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_all_destroy_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """sources_all_destroy
+
+ Prevent deletion of built-in sources
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_all_destroy_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_all_destroy
+
+ Prevent deletion of built-in sources
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_destroy_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_all_destroy_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/sources/all/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_all_list(
+ self,
+ managed: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedSourceList:
+ """sources_all_list
+
+ Source Viewset
+
+ :param managed:
+ :type managed: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_list_serialize(
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSourceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_all_list_with_http_info(
+ self,
+ managed: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedSourceList]:
+ """sources_all_list
+
+ Source Viewset
+
+ :param managed:
+ :type managed: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_list_serialize(
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSourceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_all_list_without_preload_content(
+ self,
+ managed: Optional[StrictStr] = None,
+ name: Optional[StrictStr] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ pbm_uuid: Optional[UUID] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_all_list
+
+ Source Viewset
+
+ :param managed:
+ :type managed: str
+ :param name:
+ :type name: str
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param pbm_uuid:
+ :type pbm_uuid: UUID
+ :param search: A search term.
+ :type search: str
+ :param slug:
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_list_serialize(
+ managed=managed,
+ name=name,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ pbm_uuid=pbm_uuid,
+ search=search,
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedSourceList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_all_list_serialize(
+ self,
+ managed,
+ name,
+ ordering,
+ page,
+ page_size,
+ pbm_uuid,
+ search,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if managed is not None:
+
+ _query_params.append(('managed', managed))
+
+ if name is not None:
+
+ _query_params.append(('name', name))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if pbm_uuid is not None:
+
+ _query_params.append(('pbm_uuid', pbm_uuid))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if slug is not None:
+
+ _query_params.append(('slug', slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_all_retrieve(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> Source:
+ """sources_all_retrieve
+
+ Source Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Source",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_all_retrieve_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[Source]:
+ """sources_all_retrieve
+
+ Source Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Source",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_all_retrieve_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_all_retrieve
+
+ Source Viewset
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_retrieve_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "Source",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_all_retrieve_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/all/{slug}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_all_types_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[TypeCreate]:
+ """sources_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_all_types_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[TypeCreate]]:
+ """sources_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_all_types_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_all_types_list
+
+ Get all creatable types
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_types_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[TypeCreate]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_all_types_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/all/types/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_all_used_by_list(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """sources_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_all_used_by_list_with_http_info(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """sources_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_all_used_by_list_without_preload_content(
+ self,
+ slug: StrictStr,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param slug: (required)
+ :type slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_used_by_list_serialize(
+ slug=slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_all_used_by_list_serialize(
+ self,
+ slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if slug is not None:
+ _path_params['slug'] = slug
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/all/{slug}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_all_user_settings_list(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UserSetting]:
+ """sources_all_user_settings_list
+
+ Get all sources the user can configure
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_user_settings_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UserSetting]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_all_user_settings_list_with_http_info(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UserSetting]]:
+ """sources_all_user_settings_list
+
+ Get all sources the user can configure
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_user_settings_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UserSetting]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_all_user_settings_list_without_preload_content(
+ self,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_all_user_settings_list
+
+ Get all sources the user can configure
+
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_all_user_settings_list_serialize(
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UserSetting]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_all_user_settings_list_serialize(
+ self,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/all/user_settings/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_all_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """sources_group_connections_all_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_all_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """sources_group_connections_all_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_all_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_all_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_all_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/sources/group_connections/all/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_all_list(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGroupSourceConnectionList:
+ """sources_group_connections_all_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_all_list_with_http_info(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGroupSourceConnectionList]:
+ """sources_group_connections_all_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_all_list_without_preload_content(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_all_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_all_list_serialize(
+ self,
+ group,
+ ordering,
+ page,
+ page_size,
+ search,
+ source__slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if group is not None:
+
+ _query_params.append(('group', group))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if source__slug is not None:
+
+ _query_params.append(('source__slug', source__slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/all/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_all_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ patched_group_source_connection_request: Optional[PatchedGroupSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupSourceConnection:
+ """sources_group_connections_all_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param patched_group_source_connection_request:
+ :type patched_group_source_connection_request: PatchedGroupSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_partial_update_serialize(
+ id=id,
+ patched_group_source_connection_request=patched_group_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_all_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ patched_group_source_connection_request: Optional[PatchedGroupSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupSourceConnection]:
+ """sources_group_connections_all_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param patched_group_source_connection_request:
+ :type patched_group_source_connection_request: PatchedGroupSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_partial_update_serialize(
+ id=id,
+ patched_group_source_connection_request=patched_group_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_all_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ patched_group_source_connection_request: Optional[PatchedGroupSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_all_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param patched_group_source_connection_request:
+ :type patched_group_source_connection_request: PatchedGroupSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_partial_update_serialize(
+ id=id,
+ patched_group_source_connection_request=patched_group_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_all_partial_update_serialize(
+ self,
+ id,
+ patched_group_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_group_source_connection_request is not None:
+ _body_params = patched_group_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/sources/group_connections/all/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_all_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupSourceConnection:
+ """sources_group_connections_all_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_all_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupSourceConnection]:
+ """sources_group_connections_all_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_all_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_all_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_all_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/all/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_all_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ group_source_connection_request: GroupSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupSourceConnection:
+ """sources_group_connections_all_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param group_source_connection_request: (required)
+ :type group_source_connection_request: GroupSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_update_serialize(
+ id=id,
+ group_source_connection_request=group_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_all_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ group_source_connection_request: GroupSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupSourceConnection]:
+ """sources_group_connections_all_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param group_source_connection_request: (required)
+ :type group_source_connection_request: GroupSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_update_serialize(
+ id=id,
+ group_source_connection_request=group_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_all_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ group_source_connection_request: GroupSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_all_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param group_source_connection_request: (required)
+ :type group_source_connection_request: GroupSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_update_serialize(
+ id=id,
+ group_source_connection_request=group_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_all_update_serialize(
+ self,
+ id,
+ group_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_source_connection_request is not None:
+ _body_params = group_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/sources/group_connections/all/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_all_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """sources_group_connections_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_all_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """sources_group_connections_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_all_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this group source connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_all_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this group source connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_all_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_all_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/all/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_create(
+ self,
+ group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupKerberosSourceConnection:
+ """sources_group_connections_kerberos_create
+
+ Group-source connection Viewset
+
+ :param group_kerberos_source_connection_request: (required)
+ :type group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_create_serialize(
+ group_kerberos_source_connection_request=group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_create_with_http_info(
+ self,
+ group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupKerberosSourceConnection]:
+ """sources_group_connections_kerberos_create
+
+ Group-source connection Viewset
+
+ :param group_kerberos_source_connection_request: (required)
+ :type group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_create_serialize(
+ group_kerberos_source_connection_request=group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_create_without_preload_content(
+ self,
+ group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_create
+
+ Group-source connection Viewset
+
+ :param group_kerberos_source_connection_request: (required)
+ :type group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_create_serialize(
+ group_kerberos_source_connection_request=group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_create_serialize(
+ self,
+ group_kerberos_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_kerberos_source_connection_request is not None:
+ _body_params = group_kerberos_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/sources/group_connections/kerberos/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """sources_group_connections_kerberos_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """sources_group_connections_kerberos_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/sources/group_connections/kerberos/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_list(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGroupKerberosSourceConnectionList:
+ """sources_group_connections_kerberos_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupKerberosSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_list_with_http_info(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGroupKerberosSourceConnectionList]:
+ """sources_group_connections_kerberos_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupKerberosSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_list_without_preload_content(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupKerberosSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_list_serialize(
+ self,
+ group,
+ ordering,
+ page,
+ page_size,
+ search,
+ source__slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if group is not None:
+
+ _query_params.append(('group', group))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if source__slug is not None:
+
+ _query_params.append(('source__slug', source__slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/kerberos/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ patched_group_kerberos_source_connection_request: Optional[PatchedGroupKerberosSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupKerberosSourceConnection:
+ """sources_group_connections_kerberos_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param patched_group_kerberos_source_connection_request:
+ :type patched_group_kerberos_source_connection_request: PatchedGroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_partial_update_serialize(
+ id=id,
+ patched_group_kerberos_source_connection_request=patched_group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ patched_group_kerberos_source_connection_request: Optional[PatchedGroupKerberosSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupKerberosSourceConnection]:
+ """sources_group_connections_kerberos_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param patched_group_kerberos_source_connection_request:
+ :type patched_group_kerberos_source_connection_request: PatchedGroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_partial_update_serialize(
+ id=id,
+ patched_group_kerberos_source_connection_request=patched_group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ patched_group_kerberos_source_connection_request: Optional[PatchedGroupKerberosSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param patched_group_kerberos_source_connection_request:
+ :type patched_group_kerberos_source_connection_request: PatchedGroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_partial_update_serialize(
+ id=id,
+ patched_group_kerberos_source_connection_request=patched_group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_partial_update_serialize(
+ self,
+ id,
+ patched_group_kerberos_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_group_kerberos_source_connection_request is not None:
+ _body_params = patched_group_kerberos_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/sources/group_connections/kerberos/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupKerberosSourceConnection:
+ """sources_group_connections_kerberos_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupKerberosSourceConnection]:
+ """sources_group_connections_kerberos_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/kerberos/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupKerberosSourceConnection:
+ """sources_group_connections_kerberos_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param group_kerberos_source_connection_request: (required)
+ :type group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_update_serialize(
+ id=id,
+ group_kerberos_source_connection_request=group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupKerberosSourceConnection]:
+ """sources_group_connections_kerberos_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param group_kerberos_source_connection_request: (required)
+ :type group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_update_serialize(
+ id=id,
+ group_kerberos_source_connection_request=group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param group_kerberos_source_connection_request: (required)
+ :type group_kerberos_source_connection_request: GroupKerberosSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_update_serialize(
+ id=id,
+ group_kerberos_source_connection_request=group_kerberos_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupKerberosSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_update_serialize(
+ self,
+ id,
+ group_kerberos_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_kerberos_source_connection_request is not None:
+ _body_params = group_kerberos_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/sources/group_connections/kerberos/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_kerberos_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """sources_group_connections_kerberos_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_kerberos_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """sources_group_connections_kerberos_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_kerberos_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group Kerberos Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_kerberos_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Group Kerberos Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_kerberos_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_kerberos_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/kerberos/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_create(
+ self,
+ group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupLDAPSourceConnection:
+ """sources_group_connections_ldap_create
+
+ Group-source connection Viewset
+
+ :param group_ldap_source_connection_request: (required)
+ :type group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_create_serialize(
+ group_ldap_source_connection_request=group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_create_with_http_info(
+ self,
+ group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupLDAPSourceConnection]:
+ """sources_group_connections_ldap_create
+
+ Group-source connection Viewset
+
+ :param group_ldap_source_connection_request: (required)
+ :type group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_create_serialize(
+ group_ldap_source_connection_request=group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_create_without_preload_content(
+ self,
+ group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_create
+
+ Group-source connection Viewset
+
+ :param group_ldap_source_connection_request: (required)
+ :type group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_create_serialize(
+ group_ldap_source_connection_request=group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_create_serialize(
+ self,
+ group_ldap_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_ldap_source_connection_request is not None:
+ _body_params = group_ldap_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/sources/group_connections/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """sources_group_connections_ldap_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """sources_group_connections_ldap_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/sources/group_connections/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_list(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGroupLDAPSourceConnectionList:
+ """sources_group_connections_ldap_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupLDAPSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_list_with_http_info(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[PaginatedGroupLDAPSourceConnectionList]:
+ """sources_group_connections_ldap_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupLDAPSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_list_without_preload_content(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_list_serialize(
+ group=group,
+ ordering=ordering,
+ page=page,
+ page_size=page_size,
+ search=search,
+ source__slug=source__slug,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "PaginatedGroupLDAPSourceConnectionList",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_list_serialize(
+ self,
+ group,
+ ordering,
+ page,
+ page_size,
+ search,
+ source__slug,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ if group is not None:
+
+ _query_params.append(('group', group))
+
+ if ordering is not None:
+
+ _query_params.append(('ordering', ordering))
+
+ if page is not None:
+
+ _query_params.append(('page', page))
+
+ if page_size is not None:
+
+ _query_params.append(('page_size', page_size))
+
+ if search is not None:
+
+ _query_params.append(('search', search))
+
+ if source__slug is not None:
+
+ _query_params.append(('source__slug', source__slug))
+
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/ldap/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_partial_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ patched_group_ldap_source_connection_request: Optional[PatchedGroupLDAPSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupLDAPSourceConnection:
+ """sources_group_connections_ldap_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param patched_group_ldap_source_connection_request:
+ :type patched_group_ldap_source_connection_request: PatchedGroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_partial_update_serialize(
+ id=id,
+ patched_group_ldap_source_connection_request=patched_group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_partial_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ patched_group_ldap_source_connection_request: Optional[PatchedGroupLDAPSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupLDAPSourceConnection]:
+ """sources_group_connections_ldap_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param patched_group_ldap_source_connection_request:
+ :type patched_group_ldap_source_connection_request: PatchedGroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_partial_update_serialize(
+ id=id,
+ patched_group_ldap_source_connection_request=patched_group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_partial_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ patched_group_ldap_source_connection_request: Optional[PatchedGroupLDAPSourceConnectionRequest] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_partial_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param patched_group_ldap_source_connection_request:
+ :type patched_group_ldap_source_connection_request: PatchedGroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_partial_update_serialize(
+ id=id,
+ patched_group_ldap_source_connection_request=patched_group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_partial_update_serialize(
+ self,
+ id,
+ patched_group_ldap_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if patched_group_ldap_source_connection_request is not None:
+ _body_params = patched_group_ldap_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PATCH',
+ resource_path='/sources/group_connections/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_retrieve(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupLDAPSourceConnection:
+ """sources_group_connections_ldap_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_retrieve_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupLDAPSourceConnection]:
+ """sources_group_connections_ldap_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_retrieve_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_retrieve
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_retrieve_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_retrieve_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_update(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupLDAPSourceConnection:
+ """sources_group_connections_ldap_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param group_ldap_source_connection_request: (required)
+ :type group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_update_serialize(
+ id=id,
+ group_ldap_source_connection_request=group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_update_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupLDAPSourceConnection]:
+ """sources_group_connections_ldap_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param group_ldap_source_connection_request: (required)
+ :type group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_update_serialize(
+ id=id,
+ group_ldap_source_connection_request=group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_update_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_update
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param group_ldap_source_connection_request: (required)
+ :type group_ldap_source_connection_request: GroupLDAPSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_update_serialize(
+ id=id,
+ group_ldap_source_connection_request=group_ldap_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "GroupLDAPSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_update_serialize(
+ self,
+ id,
+ group_ldap_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_ldap_source_connection_request is not None:
+ _body_params = group_ldap_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='PUT',
+ resource_path='/sources/group_connections/ldap/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_ldap_used_by_list(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> List[UsedBy]:
+ """sources_group_connections_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_ldap_used_by_list_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[List[UsedBy]]:
+ """sources_group_connections_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_ldap_used_by_list_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group LDAP Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_ldap_used_by_list
+
+ Get a list of all objects that use this object
+
+ :param id: A unique integer value identifying this Group LDAP Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_ldap_used_by_list_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '200': "List[UsedBy]",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_ldap_used_by_list_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='GET',
+ resource_path='/sources/group_connections/ldap/{id}/used_by/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_oauth_create(
+ self,
+ group_o_auth_source_connection_request: GroupOAuthSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> GroupOAuthSourceConnection:
+ """sources_group_connections_oauth_create
+
+ Group-source connection Viewset
+
+ :param group_o_auth_source_connection_request: (required)
+ :type group_o_auth_source_connection_request: GroupOAuthSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_oauth_create_serialize(
+ group_o_auth_source_connection_request=group_o_auth_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupOAuthSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_oauth_create_with_http_info(
+ self,
+ group_o_auth_source_connection_request: GroupOAuthSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[GroupOAuthSourceConnection]:
+ """sources_group_connections_oauth_create
+
+ Group-source connection Viewset
+
+ :param group_o_auth_source_connection_request: (required)
+ :type group_o_auth_source_connection_request: GroupOAuthSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_oauth_create_serialize(
+ group_o_auth_source_connection_request=group_o_auth_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupOAuthSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_oauth_create_without_preload_content(
+ self,
+ group_o_auth_source_connection_request: GroupOAuthSourceConnectionRequest,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_oauth_create
+
+ Group-source connection Viewset
+
+ :param group_o_auth_source_connection_request: (required)
+ :type group_o_auth_source_connection_request: GroupOAuthSourceConnectionRequest
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_oauth_create_serialize(
+ group_o_auth_source_connection_request=group_o_auth_source_connection_request,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '201': "GroupOAuthSourceConnection",
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_oauth_create_serialize(
+ self,
+ group_o_auth_source_connection_request,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+ if group_o_auth_source_connection_request is not None:
+ _body_params = group_o_auth_source_connection_request
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+ # set the HTTP header `Content-Type`
+ if _content_type:
+ _header_params['Content-Type'] = _content_type
+ else:
+ _default_content_type = (
+ self.api_client.select_header_content_type(
+ [
+ 'application/json'
+ ]
+ )
+ )
+ if _default_content_type is not None:
+ _header_params['Content-Type'] = _default_content_type
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='POST',
+ resource_path='/sources/group_connections/oauth/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_oauth_destroy(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group OAuth Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> None:
+ """sources_group_connections_oauth_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group OAuth Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_oauth_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ ).data
+
+
+ @validate_call
+ def sources_group_connections_oauth_destroy_with_http_info(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group OAuth Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> ApiResponse[None]:
+ """sources_group_connections_oauth_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group OAuth Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_oauth_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ response_data.read()
+ return self.api_client.response_deserialize(
+ response_data=response_data,
+ response_types_map=_response_types_map,
+ )
+
+
+ @validate_call
+ def sources_group_connections_oauth_destroy_without_preload_content(
+ self,
+ id: Annotated[StrictInt, Field(description="A unique integer value identifying this Group OAuth Source Connection.")],
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> RESTResponseType:
+ """sources_group_connections_oauth_destroy
+
+ Group-source connection Viewset
+
+ :param id: A unique integer value identifying this Group OAuth Source Connection. (required)
+ :type id: int
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: str, Optional
+ :param _headers: set to override the headers for a single
+ request; this effectively ignores the headers
+ in the spec for a single request.
+ :type _headers: dict, optional
+ :param _host_index: set to override the host_index for a single
+ request; this effectively ignores the host_index
+ in the spec for a single request.
+ :type _host_index: int, optional
+ :return: Returns the result object.
+ """ # noqa: E501
+
+ _param = self._sources_group_connections_oauth_destroy_serialize(
+ id=id,
+ _request_auth=_request_auth,
+ _content_type=_content_type,
+ _headers=_headers,
+ _host_index=_host_index
+ )
+
+ _response_types_map: Dict[str, Optional[str]] = {
+ '204': None,
+ '400': "ValidationError",
+ '403': "GenericError",
+ }
+ response_data = self.api_client.call_api(
+ *_param,
+ _request_timeout=_request_timeout
+ )
+ return response_data.response
+
+
+ def _sources_group_connections_oauth_destroy_serialize(
+ self,
+ id,
+ _request_auth,
+ _content_type,
+ _headers,
+ _host_index,
+ ) -> RequestSerialized:
+
+ _host = None
+
+ _collection_formats: Dict[str, str] = {
+ }
+
+ _path_params: Dict[str, str] = {}
+ _query_params: List[Tuple[str, str]] = []
+ _header_params: Dict[str, Optional[str]] = _headers or {}
+ _form_params: List[Tuple[str, str]] = []
+ _files: Dict[
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+ ] = {}
+ _body_params: Optional[bytes] = None
+
+ # process the path parameters
+ if id is not None:
+ _path_params['id'] = id
+ # process the query parameters
+ # process the header parameters
+ # process the form parameters
+ # process the body parameter
+
+
+ # set the HTTP header `Accept`
+ if 'Accept' not in _header_params:
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ [
+ 'application/json'
+ ]
+ )
+
+
+ # authentication setting
+ _auth_settings: List[str] = [
+ 'authentik'
+ ]
+
+ return self.api_client.param_serialize(
+ method='DELETE',
+ resource_path='/sources/group_connections/oauth/{id}/',
+ path_params=_path_params,
+ query_params=_query_params,
+ header_params=_header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ auth_settings=_auth_settings,
+ collection_formats=_collection_formats,
+ _host=_host,
+ _request_auth=_request_auth
+ )
+
+
+
+
+ @validate_call
+ def sources_group_connections_oauth_list(
+ self,
+ group: Optional[UUID] = None,
+ ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None,
+ page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None,
+ page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
+ search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None,
+ source__slug: Optional[StrictStr] = None,
+ _request_timeout: Union[
+ None,
+ Annotated[StrictFloat, Field(gt=0)],
+ Tuple[
+ Annotated[StrictFloat, Field(gt=0)],
+ Annotated[StrictFloat, Field(gt=0)]
+ ]
+ ] = None,
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
+ _content_type: Optional[StrictStr] = None,
+ _headers: Optional[Dict[StrictStr, Any]] = None,
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+ ) -> PaginatedGroupOAuthSourceConnectionList:
+ """sources_group_connections_oauth_list
+
+ Group-source connection Viewset
+
+ :param group:
+ :type group: UUID
+ :param ordering: Which field to use when ordering the results.
+ :type ordering: str
+ :param page: A page number within the paginated result set.
+ :type page: int
+ :param page_size: Number of results to return per page.
+ :type page_size: int
+ :param search: A search term.
+ :type search: str
+ :param source__slug:
+ :type source__slug: str
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :type _request_timeout: int, tuple(int, int), optional
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the
+ authentication in the spec for a single request.
+ :type _request_auth: dict, optional
+ :param _content_type: force content-type for the request.
+ :type _content_type: