locations

The following methods allow for interaction with the ZIA Location Management API endpoints.

Methods are accessible via zia.locations

Copyright (c) 2023, Zscaler Inc.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class LocationsAPI

Bases: APIClient

A Client object for the Locations resource.

add_location(**kwargs)

Adds a new location.

Parameters:

location (dict or object) – The label data to be sent in the request.

Keyword Arguments:

  • parent_id (int, optional) – Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location.

  • up_bandwidth (int, optional) – Upload bandwidth in kbps. The value 0 implies no Bandwidth Control enforcement. Default: 0.

  • dn_bandwidth (int, optional) – Download bandwidth in kbps. The value 0 implies no Bandwidth Control enforcement. Default: 0.

  • country (str, optional) – Country.

  • tz (str, optional) – Timezone of the location. If not specified, it defaults to GMT.

  • ip_addresses (list[str], optional) –

    For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9).

    For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).

  • ports (list[int], optional) – IP ports that are associated with the location.

  • vpn_credentials (list, optional) – VPN User Credentials that are associated with the location.

  • auth_required (bool, optional) – Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled. Default: False.

  • ssl_scan_enabled (bool, optional) – Enable SSL Inspection. Set to true in order to apply your SSL Inspection policy to HTTPS traffic in the location and inspect HTTPS transactions for data leakage, malicious content, and viruses. Default: False.

  • zapp_ssl_scan_enabled (bool, optional) – Enable Zscaler App SSL Setting. When set to true, the Zscaler App SSL Scan Setting takes effect, irrespective of the SSL policy that is configured for the location. Default: False.

  • xff_forward_enabled (bool, optional) – Enable XFF Forwarding for a location. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header. Default: False.

  • other_sub_location (bool, optional) – If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. Default: False.

  • other6_sub_location (bool, optional) – If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. Default: False.

  • surrogate_ip (bool, optional) – Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses. Default: False.

  • idle_time_in_minutes (int, optional) – Idle Time to Disassociation. The user mapping idle time (in minutes) is required if Surrogate IP is enabled.

  • display_time_unit (str, optional) – Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.

  • surrogate_ip_enforced_for_known_browsers (bool, optional) – Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers. Default: False.

  • surrogate_refresh_time_in_minutes (int, optional) – Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.

  • surrogate_refresh_time_unit (str, optional) – Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.

  • ofw_enabled (bool, optional) – Enable Firewall. When set to true, Firewall is enabled for the location. Default: False.

  • ips_control (bool, optional) – Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled. Default: False.

  • aup_enabled (bool, optional) – Enable AUP. When set to true, AUP is enabled for the location. Default: False.

  • caution_enabled (bool, optional) – Enable Caution. When set to true, a caution notification is enabled for the location. Default: False.

  • aup_block_internet_until_accepted (bool, optional) – For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP. Default: False.

  • aup_force_ssl_inspection (bool, optional) – For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler forces SSL Inspection in order to enforce AUP for HTTPS traffic. Default: False.

  • ipv6_enabled (bool, optional) – If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.

  • ipv6_dns64_prefix (str, optional) – Name-ID pair of the NAT64 prefix configured as the DNS64 prefix for the location.

  • aup_timeout_in_days (int, optional) – Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.

  • managed_by (str, optional) – SD-WAN Partner that manages the location. If a partner does not manage the location, this is set to Self.

  • profile (str, optional) – Profile tag that specifies the location traffic type. If not specified, this tag defaults to “Unassigned”.

  • description (str, optional) – Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.

  • sub_loc_scope_enabled (bool, optional) – Indicates whether defining scopes is allowed for this sublocation

  • sub_loc_scope (str, optional) – Defines a scope for the sublocation from the available types to segregate workload traffic

  • sub_loc_scope_values (list[str], optional) – Specifies values for the selected sublocation scope type

  • sub_loc_acc_ids (list[int], optional) – Specifies one or more Amazon Web Services (AWS) account IDs.

Returns:

The newly created location resource record

Return type:

tuple

Examples

Add a new location with a VPN Credential and Static IP Address.

>>> added_location, _, err = client.zia.locations.add_location(
...     name=f"NewLocation_{random.randint(1000, 10000)}",
...     description=f"NewLocation_{random.randint(1000, 10000)}",
...     country='UNITED_STATES',
...     tz="UNITED_STATES_AMERICA_LOS_ANGELES",
...     xff_forward_enabled=True,
...     ofw_enabled=True,
...     ips_control=True,
...     profile="SERVER",
...     vpn_credentials=[
...         {
...             "id": 22223992,
...             "type": "UFQDN"
...         }
...     ],
... )
>>> if err:
...     print(f"Error adding location: {err}")
...     return
... print(f"location added successfully: {added_location.as_dict()}")
bulk_delete_locations(location_ids)

Deletes all specified Location Management from ZIA.

Parameters:

location_ids (list) – The list of unique ids for the ZIA Locations that will be deleted.

Returns:

The status code for the operation.

Return type:

int

Examples

>>> location_ids_to_delete = ['8665786', '8766865']
... bulk_delete_response, _, err = client.zia.locations.bulk_delete_locations(location_ids_to_delete)
>>> if err:
...     print(f"Error in bulk deleting locations: {err}")
...     return
...  print(f"Bulk delete operation successful. Response: {bulk_delete_response}")
delete_location(location_id)

Deletes the location or sub-location for the specified ID

Parameters:

location_id (int) – The unique identifier for the location or sub-location.

Returns:

Response code for the operation.

Return type:

int

Examples

>>> _, _, err = client.zia.locations.delete_location('123454')
>>> if err:
...     print(f"Error deleting location: {err}")
...     return
... print(f"location with ID {'123454'} deleted successfully.")
get_geo_by_ip(ip)

Retrieves the geographical data of the region or city that is located in the specified IP address. The geographical data includes the city name, state, country, geographical ID of the city and state, etc.

Parameters:

ip (str) – The IP address of the location.

Returns:

The geographical data of the region or city that is located in the specified IP address.

Return type:

tuple

Examples

Get the geographical data of the region or city that is located in the specified IP address:

>>> fetched_ip, _, error = client.zia.locations.get_geo_by_ip("8.8.8.8")
>>> if error:
...     print(f"Error fetching geo by IP: {error}")
...     return
... print(f"Fetched geo by IP: {fetched_ip.as_dict()}")
get_location(location_id)

Returns information for the specified location based on the location id or location name.

Parameters:

location_id (int) – The unique identifier for the location.

Returns:

A tuple containing (Location instance, Response, error).

Return type:

tuple

Examples

>>> fetched_location, _, err = client.zia.locations.get_location(updated_location.id)
>>> if err:
...     print(f"Error fetching location by ID: {err}")
...     return
... print(f"Fetched location by ID: {fetched_location.as_dict()}")
get_location_group(group_id)

Fetches a specific location group for the specified ID.

Parameters:

group_id (int) – The unique identifier for the location group.

Returns:

A tuple containing (Rule Label instance, Response, error).

Return type:

tuple

Examples

Get a list of all configured location groups:

>>> fetched_location, _, err = client.zia.locations.get_location_group('87687')
>>> if err:
...     print(f"Error fetching location by ID: {err}")
...     return
... print(f"Fetched location by ID: {fetched_location.as_dict()}")
get_supported_countries()

Retrieves the list of countries supported in location configuration Note: The response shows the current list of supported values in an Enum list. However, this list might vary if new entries are added or existing values are modified and the request always returns the latest information available about the countries.

Args:

Returns:

A tuple containing (Location instance, Response, error).

Return type:

tuple

Examples

>>> fetched_location, _, err = client.zia.locations.get_location(updated_location.id)
>>> if err:
...     print(f"Error fetching location by ID: {err}")
...     return
... print(f"Fetched location by ID: {fetched_location.as_dict()}")
list_cities_by_name(query_params=None)

Retrieves the list of cities (along with their geographical data) that match the prefix search. The geographical data includes the latitude and longitude coordinates of the city, geographical ID of the city and state, country, postal code, etc.

Parameters:

{dict} (query_params) –

Map of query parameters for the request. [query_params.page] {int}: Specifies the page offset. [query_params.page_size] {int}: Page size for pagination.

[query_params.prefix] {str}: Prefix search of the city or region.

It can contain names of city, state, country in the following format: city name, state name, country name.

Returns:

A list of dictionaries containing the cities’ geographical data and the raw response.

Return type:

tuple

Examples

Get the list of cities (along with their geographical data) that match the prefix search:

>>> city_list, _, error = client.zia.locations.list_cities_by_name(query_params={"prefix": "San Jose"})
>>> if error:
...     print(f"Error listing cities: {error}")
...     return
... print(f"Total cities found: {len(city_list)}")
... for city in city_list:
...     print(city.as_dict())

Notes

Very broad or generic search terms may return a large number of results which can take a long time to be returned. Ensure you narrow your search result as much as possible to avoid this.

list_location_groups(query_params=None)

Return a list of location groups in ZIA.

Parameters:

{dict} (query_params) –

Map of query parameters for the request.

[query_params.page] {int}: Page size for pagination.

[query_params.page_size] {int}: Specifies the page size.

The default size is 100, but the maximum size is 1000.

[query_params.search] {str}: Search string for filtering results [query_params.group_type] {str}: The location group’s type (i.e., Static or Dynamic) [query_params.name] {str}: The location group’s name [query_params.last_mod_user] {str}: The location group’s name [query_params.version] {int}: The version parameter is for Zscaler internal use only [query_params.comments] {str}: Additional comments or information about the location group [query_params.location_id] {int}: The unique identifier for a location within a location group [query_params.fetch_locations] {bool}: Fetches locations associated with the group.

Keyword Args:

Returns:

A list of location group resource records.

Return type:

Tuple

Examples

Get a list of all configured location groups:

>>> locations_list, _, err = client.zia.locations.list_location_groups()
>>> if err:
...     print(f"Error listing locations: {err}")
...     return
... print(f"Total locations found: {len(locations_list)}")
... for location in locations_list:
...     print(location.as_dict())
list_location_groups_count(query_params=None)

Returns a list of location groups for your organization.

Parameters:

{dict} (query_params) – Map of query parameters for the request. [query_params.group_type] {str}: The location group’s type (i.e., Static or Dynamic). [query_params.name] {str}: The location group’s name. [query_params.last_mod_user] {str}: The location group’s name. [query_params.comments] {str}: Additional comments or information about the location group. [query_params.location_id] {int}: The unique identifier for a location within a location group.

Keyword Args:

Returns:

A list of location group resource records.

Return type:

Tuple

Examples

Gets the list of location groups for your organization:

>>> count, _, error = client.zia.locations.list_location_groups_count()
>>> if error:
...     print(f"Error fetching location group count: {error}")
...     return
... print(f"Total location groups found: {count}")
list_location_groups_lite(query_params=None)

Returns a list of location groups (lite version) by their ID where only name and ID is returned in ZIA.

Parameters:

{dict} (query_params) –

Map of query parameters for the request. [query_params.page] {int}: Page size for pagination.

[query_params.page_size] {int}: Specifies the page size.

The default size is 100, but the maximum size is 1000.

[query_params.search] {str}: Search string for filtering results.

Keyword Args:

Returns:

A list of location group resource records.

Return type:

Tuple

Examples

Get a list of all configured location groups:

>>> locations_list, _, err = client.zia.locations.list_location_groups_lite()
>>> if err:
...     print(f"Error listing locations: {err}")
...     return
... print(f"Total locations found: {len(locations_list)}")
... for location in locations_list:
...     print(location.as_dict())
list_locations(query_params=None)

Returns a list of locations.

Parameters:

query_params (dict) –

Map of query parameters for the request.

[query_params.page] (int): Specifies the page offset.

[query_params.page_size] (int): Specifies the page size.

The default size is 100, but the maximum size is 1000.

[query_params.search] (str): String used to partially match against a location’s name and port attributes.

[query_params.ssl_scan_enabled] (bool): Parameter was deprecated and no longer has an effect on SSL policy.

[query_params.xff_enabled] (bool):

Filter based on whether the Enforce XFF Forwarding setting is enabled or disabled for a location.

[query_params.auth_required] (bool):

Filter based on whether the Enforce Authentication setting is enabled or disabled for a location.

[query_params.bw_enforced] (bool):

Filter based on whether Bandwidth Control is being enforced for a location.

[query_params.enable_iot] (bool):

If set to true, the city field (containing IoT-enabled location IDs, names, latitudes, and longitudes) and the iotDiscoveryEnabled filter are included in the response. Otherwise, they are not included.

Returns:

List of configured locations as (LocationManagement, Response, error).

Return type:

tuple

Examples

List all locations:

>>> locations_list, _, err = client.zia.locations.list_locations()
>>> if err:
...     print(f"Error listing locations: {err}")
...     return
... print(f"Total locations found: {len(locations_list)}")
... for location in locations_list:
...     print(location.as_dict())
Filter locations:

>>> locations_list, _, err = client.zia.locations.list_locations(
... query_params={'page': 1, 'page_size': 10, 'search': 'HQ_SanJose'}
)
>>> if err:
...     print(f"Error listing locations: {err}")
...     return
... print(f"Total locations found: {len(locations_list)}")
... for location in locations_list:
...     print(location.as_dict())
list_locations_lite(query_params=None)

Returns only the name and ID of all configured locations.

Keyword Arguments:

{dict} (query_params) –

Optional query parameters.

[query_params.page] {int}: Specifies the page offset.

[query_params.page_size] {int}: Specifies the page size.

The default size is 100, but the maximum size is 1000.

[query_params.state] {str}: Filter based on geographical state for a location.

[query_params.xff_enabled] {bool}: Filter based on whether xff_enabled is true for a location.

[query_params.auth_required] {bool}: Filter based on whether Enforce Authentication is enabled.

[query_params.bw_enforced] {bool}: Filter based on whether Bandwith Control is enforced for a location.

[query_params.partner_id] {bool}: Not applicable to Cloud & Branch Connector.

[query_params.enforce_aup] {bool}: Filter based on whether Acceptable Use Policy (AUP) is enforced.

[query_params.enable_firewall] {bool}: Filter based on whether firewall is enabled for a location.

[query_params.location_type] {bool}: Filter based on type of location.

Supported values: NONE, CORPORATE, SERVER, GUESTWIFI, IOT, WORKLOAD

Returns:

A list of configured locations.

Return type:

Tuple

Examples

List locations with default settings:

>>> locations_list, _, err = client.zia.locations.list_locations_lite()
>>> if err:
...     print(f"Error listing locations: {err}")
...     return
... print(f"Total locations found: {len(locations_list)}")
... for location in locations_list:
...     print(location.as_dict())
list_region_geo_coordinates(latitude, longitude)

Retrieves the geographical data of the region or city that is located in the specified latitude and longitude coordinates. The geographical data includes the city name, state, country, geographical ID of the city and state, etc.

Parameters:

  • latitude (float) – The latitude of the location.

  • longitude (float) – The longitude of the location.

Returns:

The geographical data of the region or city that is located in the specified coordinates.

Return type:

tuple

Examples

Get the geographical data of the region or city that is located in the specified coordinates:

>>> fetched_ip, _, error = client.zia.locations.list_region_geo_coordinates(
...     latitude = "37.3860517", longitude = "-122.0838511")
>>> if error:
...     print(f"Error fetching coordinates by latitude and longitude: {error}")
...     return
... print(f"Fetched coordinates by latitude and longitude: {fetched_ip.as_dict()}")
list_sub_locations(location_id, query_params=None)

Returns sub-location information for the specified location ID.

Parameters:

  • location_id (int) – The unique identifier for the parent location.

  • {dict} (query_params) – Map of query parameters for the request. [query_params.page_size] {int}: Page size for pagination. [query_params.search] {str}: Search string for filtering results.

Keyword Arguments:

  • **auth_required (bool, optional) – Filter based on whether the Enforce Authentication setting is enabled or disabled for a location.

  • **bw_enforced (bool, optional) – Filter based on whether Bandwith Control is being enforced for a location.

  • **enable_firewall (bool, optional) – Filter based on whether Enable Firewall setting is enabled or disabled for a sub-location.

  • **enforce_aup (bool, optional) – Filter based on whether Enforce AUP setting is enabled or disabled for a sub-location.

  • **max_items (int, optional) – The maximum number of items to request before stopping iteration.

  • **max_pages (int, optional) – The maximum number of pages to request before stopping iteration.

  • **page_size (int, optional) – Specifies the page size. The default size is 100, but the maximum size is 1000.

  • **search (str, optional) – The search string used to partially match against a location’s name and port attributes.

  • **xff_enabled (bool, optional) – Filter based on whether the Enforce XFF Forwarding setting is enabled or disabled for a location.

Returns:

A list of sub-locations configured for the parent location.

Return type:

Tuple

Examples

>>> locations_list, _, err = client.zia.locations.list_sub_locations()
>>> if err:
...     print(f"Error listing locations: {err}")
...     return
... print(f"Total locations found: {len(locations_list)}")
... for location in locations_list:
...     print(location.as_dict())
update_location(location_id, **kwargs)

Update the specified location.

Note: Changes are not additive and will replace existing values.

Parameters:

  • location_id (str) – The unique identifier for the location you are updating.

  • **kwargs – Optional keyword arguments.

Keyword Arguments:

  • name (str, optional) – Location name.

  • parent_id (int, optional) – Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location.

  • up_bandwidth (int, optional) – Upload bandwidth in kbps. The value 0 implies no Bandwidth Control enforcement.

  • dn_bandwidth (int, optional) – Download bandwidth in kbps. The value 0 implies no Bandwidth Control enforcement.

  • country (str, optional) – Country.

  • tz (str, optional) – Timezone of the location. If not specified, it defaults to GMT.

  • ip_addresses (list[str], optional) –

    For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9).

    For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).

  • ports (list[int], optional) – IP ports that are associated with the location.

  • vpn_credentials (list, optional) – VPN User Credentials that are associated with the location.

  • auth_required (bool, optional) –

    Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos

    Authentication is enabled.

  • ssl_scan_enabled (bool, optional) – Enable SSL Inspection. Set to true in order to apply your SSL Inspection policy to HTTPS traffic in the location and inspect HTTPS transactions for data leakage, malicious content, and viruses.

  • zapp_ssl_scan_enabled (bool, optional) – Enable Zscaler App SSL Setting. When set to true, the Zscaler App SSL Scan Setting takes effect, irrespective of the SSL policy that is configured for the location.

  • xff_forward_enabled (bool, optional) – Enable XFF Forwarding for a location. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.

  • other_sub_location (bool, optional) – If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations.

  • other6_sub_location (bool, optional) – If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations.

  • surrogate_ip (bool, optional) – Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.

  • idle_time_in_minutes (int, optional) – Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.

  • display_time_unit (str, optional) – Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.

  • surrogate_ip_enforced_for_known_browsers (bool, optional) – Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.

  • surrogate_refresh_time_in_minutes (int, optional) – Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.

  • surrogate_refresh_time_unit (str, optional) – Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.

  • ofw_enabled (bool, optional) – Enable Firewall. When set to true, Firewall is enabled for the location.

  • ips_control (bool, optional) – Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.

  • aup_enabled (bool, optional) – Enable AUP. When set to true, AUP is enabled for the location.

  • caution_enabled (bool, optional) – Enable Caution. When set to true, a caution notification is enabled for the location.

  • aup_block_internet_until_accepted (bool, optional) – For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.

  • aup_force_ssl_inspection (bool, optional) – For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler forces SSL Inspection in order to enforce AUP for HTTPS traffic.

  • ipv6_enabled (bool, optional) – If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.

  • ipv6_dns64_prefix (str, optional) – Name-ID pair of the NAT64 prefix configured as the DNS64 prefix for the location.

  • aup_timeout_in_days (int, optional) – Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.

  • managed_by (str, optional) – SD-WAN Partner that manages the location. If a partner does not manage the location, this is set to Self.

  • profile (str, optional) – Profile tag that specifies the location traffic type. If not specified, this tag defaults to “Unassigned”.

  • description (str, optional) – Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.

Returns:

The updated resource record.

Return type:

tuple

Examples

Update location Enable Surrogate IP:

>>> update_location, _, err = client.zia.locations.update_location(
...     location_id='546874',
...     name=f"UpdateLocation_{random.randint(1000, 10000)}",
...     description=f"NewLocation_{random.randint(1000, 10000)}",
...     country='UNITED_STATES',
...     tz="UNITED_STATES_AMERICA_LOS_ANGELES",
...     auth_required=True,
...     idle_time_in_minutes='720',
...     display_time_unit="MINUTE",
...     surrogate_ip=True,
...     xff_forward_enabled=True,
...     ofw_enabled=True,
...     ips_control=True,
...     profile="SERVER",
...     vpn_credentials=[
...         {
...             "id": 22223992,
...             "type": "UFQDN"
...         }
...     ],
... )
>>> if err:
...     print(f"Error updating location: {err}")
...     return
... print(f"location updated successfully: {update_location.as_dict()}")