profile module

Copyright 2023 Sophos Ltd. All rights reserved. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class profile.AdminProfile(api_client)

Bases: object

Class for working with Administration Profile(s).

create(name: str, default_permission: str = None, debug: bool = False, **kwargs)

Create an administration profile.

Parameters:

• name (str) – Name of administration profile

• default_permission (str, optional) – Permissions to use for unspecified settings (None, Read-Only, Read-Write). Defaults to None.

• debug (bool, optional) – Turn on debugging. Defaults to False.

Keyword Arguments:

• dashboard (str, optional) – Dashboard permission (None, Read-Only, Read-Write). Defaults to None.

• wizard (str, optional) – Wizard permission (None, Read-Only, Read-Write). Defaults to None.

• set_system_profile (str, optional) – System Profile permission (None, Read-Only, Read-Write). Defaults to None.

• profile (str, optional) – Profile permission (None, Read-Only, Read-Write). Defaults to None.

• system_password (str, optional) – System Password permission (None, Read-Only, Read-Write). Defaults to None.

• central_management (str, optional) – Central management permission (None, Read-Only, Read-Write). Defaults to None.

• backup (str, optional) – Backup permission (None, Read-Only, Read-Write). Defaults to None.

• restore (str, optional) – Restore permission (None, Read-Only, Read-Write). Defaults to None.

• firmware (str, optional) – Firmware permission (None, Read-Only, Read-Write). Defaults to None.

• licensing (str, optional) – Licensing permission (None, Read-Only, Read-Write). Defaults to None.

• services (str, optional) – Services permission (None, Read-Only, Read-Write). Defaults to None.

• updates (str, optional) – Updates permission (None, Read-Only, Read-Write). Defaults to None.

• reboot_shutdown (str, optional) – Reboot/Shutdown permission (None, Read-Only, Read-Write). Defaults to None.

• ha (str, optional) – HA permission (None, Read-Only, Read-Write). Defaults to None.

• download_certificates (str, optional) – Download certificates permission (None, Read-Only, Read-Write). Defaults to None.

• other_certificate_configuration (str, optional) – Other certificate configuration permission (None, Read-Only, Read-Write). Defaults to None.

• diagnostics (str, optional) – Diagnostics permission (None, Read-Only, Read-Write). Defaults to None.

• other_system_configuration (str, optional) – Other system configuration permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_overview (str, optional) – Wireless protection overview permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_settings (str, optional) – Wireless protection settings permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_network (str, optional) – Wireless protection network permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_access_point (str, optional) – Wireless protection access point permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_mesh (str, optional) – Wireless protection mesh permission (None, Read-Only, Read-Write). Defaults to None.

• objects (str, optional) – Objects permission (None, Read-Only, Read-Write). Defaults to None.

• network (str, optional) – Network permission (None, Read-Only, Read-Write). Defaults to None.

• set_identity_profile (str, optional) – Set identity profile permission (None, Read-Only, Read-Write). Defaults to None.

• authentication (str, optional) – Authentication permission (None, Read-Only, Read-Write). Defaults to None.

• groups (str, optional) – Groups permission (None, Read-Only, Read-Write). Defaults to None.

• guest_users_management (str, optional) – Guest users management permission (None, Read-Only, Read-Write). Defaults to None.

• other_guest_user_settings (str, optional) – Other guest user settings permission (None, Read-Only, Read-Write). Defaults to None.

• policy (str, optional) – Policy permissions (None, Read-Only, Read-Write). Defaults to None.

• test_external_server_connectivity (str, optional) – Test external server connectivity permission (None, Read-Only, Read-Write). Defaults to None.

• disconnect_live_user (str, optional) – Disconnect live user permission (None, Read-Only, Read-Write). Defaults to None.

• firewall (str, optional) – Firewall permission (None, Read-Only, Read-Write). Defaults to None.

• set_vpn_profile (str, optional) – Set vpn profile permission (None, Read-Only, Read-Write). Defaults to None.

• connect_tunnel (str, optional) – Connect tunnel permission (None, Read-Only, Read-Write). Defaults to None.

• other_vpn_configurations (str, optional) – Other VPN configuration permission (None, Read-Only, Read-Write). Defaults to None.

• ips (str, optional) – IPS permission (None, Read-Only, Read-Write). Defaults to None.

• web_filter (str, optional) – Web filter permission (None, Read-Only, Read-Write). Defaults to None.

• cloud_application_dashboard (str, optional) – Cloud application dashboard permission (None, Read-Only, Read-Write). Defaults to None.

• zero_day_protection (str, optional) – Zero day protection permission (None, Read-Only, Read-Write). Defaults to None.

• application_filter (str, optional) – Application filter permission (None, Read-Only, Read-Write). Defaults to None.

• set_waf_profile (str, optional) – Set WAF profile permission (None, Read-Only, Read-Write). Defaults to None.

• alerts (str, optional) – Alerts permission (None, Read-Only, Read-Write). Defaults to None.

• other_waf_configuration (str, optional) – Other WAF configuration permission (None, Read-Only, Read-Write). Defaults to None.

• email_protection (str, optional) – Email protection permission (None, Read-Only, Read-Write). Defaults to None.

• qos (str, optional) – QoS permission (None, Read-Only, Read-Write). Defaults to None.

• traffic_discovery (str, optional) – Traffic discovery permission (None, Read-Only, Read-Write). Defaults to None.

• set_logs_reports_profile (str, optional) – Set logs reports profile permission (None, Read-Only, Read-Write). Defaults to None.

• configuration (str, optional) – Log reports configuration permission (None, Read-Only, Read-Write). Defaults to None.

• log_viewer (str, optional) – Log viewer permission (None, Read-Only, Read-Write). Defaults to None.

• reports_access (str, optional) – Reports access permission (None, Read-Only, Read-Write). Defaults to None.

• four_eye_authentication_settings (str, optional) – Four-eye authentication settings permission (None, Read-Only, Read-Write). Defaults to None.

• de_anonymization (str, optional) – Log De-anonymization permission (None, Read-Only, Read-Write). Defaults to None.

Returns:

XML response converted to Python dictionary

Return type:

dict

get(name, operator='=')

Get admin profiles

Parameters:

• name (str, optional) – Name of profile. Returns all if not specified.

• operator (str, optional) – Operator for search. Default is “=”. Valid operators: =, !=, like.

Returns:

XML response converted to Python dictionary

Return type:

dict

update(name, debug: bool = False, **kwargs)

Update an administration profile.

Parameters:

• name (str) – Name of administration profile

• debug (bool, optional) – Turn on debugging. Defaults to False.

Keyword Arguments:

• dashboard (str, optional) – Dashboard permission (None, Read-Only, Read-Write). Defaults to None.

• wizard (str, optional) – Wizard permission (None, Read-Only, Read-Write). Defaults to None.

• set_system_profile (str, optional) – System Profile permission (None, Read-Only, Read-Write). Defaults to None.

• profile (str, optional) – Profile permission (None, Read-Only, Read-Write). Defaults to None.

• system_password (str, optional) – System Password permission (None, Read-Only, Read-Write). Defaults to None.

• central_management (str, optional) – Central management permission (None, Read-Only, Read-Write). Defaults to None.

• backup (str, optional) – Backup permission (None, Read-Only, Read-Write). Defaults to None.

• restore (str, optional) – Restore permission (None, Read-Only, Read-Write). Defaults to None.

• firmware (str, optional) – Firmware permission (None, Read-Only, Read-Write). Defaults to None.

• licensing (str, optional) – Licensing permission (None, Read-Only, Read-Write). Defaults to None.

• services (str, optional) – Services permission (None, Read-Only, Read-Write). Defaults to None.

• updates (str, optional) – Updates permission (None, Read-Only, Read-Write). Defaults to None.

• reboot_shutdown (str, optional) – Reboot/Shutdown permission (None, Read-Only, Read-Write). Defaults to None.

• ha (str, optional) – HA permission (None, Read-Only, Read-Write). Defaults to None.

• download_certificates (str, optional) – Download certificates permission (None, Read-Only, Read-Write). Defaults to None.

• other_certificate_configuration (str, optional) – Other certificate configuration permission (None, Read-Only, Read-Write). Defaults to None.

• diagnostics (str, optional) – Diagnostics permission (None, Read-Only, Read-Write). Defaults to None.

• other_system_configuration (str, optional) – Other system configuration permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_overview (str, optional) – Wireless protection overview permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_settings (str, optional) – Wireless protection settings permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_network (str, optional) – Wireless protection network permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_access_point (str, optional) – Wireless protection access point permission (None, Read-Only, Read-Write). Defaults to None.

• wireless_protection_mesh (str, optional) – Wireless protection mesh permission (None, Read-Only, Read-Write). Defaults to None.

• objects (str, optional) – Objects permission (None, Read-Only, Read-Write). Defaults to None.

• network (str, optional) – Network permission (None, Read-Only, Read-Write). Defaults to None.

• set_identity_profile (str, optional) – Set identity profile permission (None, Read-Only, Read-Write). Defaults to None.

• authentication (str, optional) – Authentication permission (None, Read-Only, Read-Write). Defaults to None.

• groups (str, optional) – Groups permission (None, Read-Only, Read-Write). Defaults to None.

• guest_users_management (str, optional) – Guest users management permission (None, Read-Only, Read-Write). Defaults to None.

• other_guest_user_settings (str, optional) – Other guest user settings permission (None, Read-Only, Read-Write). Defaults to None.

• policy (str, optional) – Policy permissions (None, Read-Only, Read-Write). Defaults to None.

• test_external_server_connectivity (str, optional) – Test external server connectivity permission (None, Read-Only, Read-Write). Defaults to None.

• disconnect_live_user (str, optional) – Disconnect live user permission (None, Read-Only, Read-Write). Defaults to None.

• firewall (str, optional) – Firewall permission (None, Read-Only, Read-Write). Defaults to None.

• set_vpn_profile (str, optional) – Set vpn profile permission (None, Read-Only, Read-Write). Defaults to None.

• connect_tunnel (str, optional) – Connect tunnel permission (None, Read-Only, Read-Write). Defaults to None.

• other_vpn_configurations (str, optional) – Other VPN configuration permission (None, Read-Only, Read-Write). Defaults to None.

• ips (str, optional) – IPS permission (None, Read-Only, Read-Write). Defaults to None.

• web_filter (str, optional) – Web filter permission (None, Read-Only, Read-Write). Defaults to None.

• cloud_application_dashboard (str, optional) – Cloud application dashboard permission (None, Read-Only, Read-Write). Defaults to None.

• zero_day_protection (str, optional) – Zero day protection permission (None, Read-Only, Read-Write). Defaults to None.

• application_filter (str, optional) – Application filter permission (None, Read-Only, Read-Write). Defaults to None.

• set_waf_profile (str, optional) – Set WAF profile permission (None, Read-Only, Read-Write). Defaults to None.

• alerts (str, optional) – Alerts permission (None, Read-Only, Read-Write). Defaults to None.

• other_waf_configuration (str, optional) – Other WAF configuration permission (None, Read-Only, Read-Write). Defaults to None.

• im (str, optional) – IM permission (None, Read-Only, Read-Write). Defaults to None.

• qos (str, optional) – QoS permission (None, Read-Only, Read-Write). Defaults to None.

• email_protection (str, optional) – Email protection permission (None, Read-Only, Read-Write). Defaults to None.

• traffic_discovery (str, optional) – Traffic discovery permission (None, Read-Only, Read-Write). Defaults to None.

• set_logs_reports_profile (str, optional) – Set logs reports profile permission (None, Read-Only, Read-Write). Defaults to None.

• configuration (str, optional) – Log reports configuration permission (None, Read-Only, Read-Write). Defaults to None.

• log_viewer (str, optional) – Log viewer permission (None, Read-Only, Read-Write). Defaults to None.

• reports_access (str, optional) – Reports access permission (None, Read-Only, Read-Write). Defaults to None.

• four_eye_authentication_settings (str, optional) – Four-eye authentication settings permission (None, Read-Only, Read-Write). Defaults to None.

• de_anonymization (str, optional) – Log De-anonymization permission (None, Read-Only, Read-Write). Defaults to None.

Returns:

XML response converted to Python dictionary

Return type:

dict