Location Schema

Data structure for Location objects.

Fields

Field	Type	Required	Description	Notes
`aup_block_internet_until_accepted`	boolean	No	-	API field: `aup_block_internet_until_accepted`
`aup_enabled`	boolean	No	-	API field: `aup_enabled`
`aup_force_ssl_inspection`	boolean	No	-	API field: `aup_force_ssl_inspection`
`aup_timeout_in_days`	integer	No	-	API field: `aup_timeout_in_days`
`auth_required`	boolean	No	-	API field: `auth_required`
`authentication_profile`	EntityReference	No	-	API field: `authentication_profile`
`basic_auth_enabled`	boolean	No	-	API field: `basic_auth_enabled`
`bc_location`	boolean	No	-	API field: `bc_location`
`caution_enabled`	boolean	No	-	API field: `caution_enabled`
`cc_location`	boolean	No	-	API field: `cc_location`
`child_count`	integer	No	-	API field: `child_count`
`city`	EntityReference	No	-	-
`city_geo_id`	integer	No	-	API field: `city_geo_id`
`cookies_and_proxy`	boolean	No	-	API field: `cookies_and_proxy`
`country`	string	No	-	-
`default_extranet_dns`	boolean	No	-	API field: `default_extranet_dns`
`default_extranet_ts_pool`	boolean	No	-	API field: `default_extranet_ts_pool`
`description`	string	No	-	-
`digest_auth_enabled`	boolean	No	-	API field: `digest_auth_enabled`
`display_time_unit`	string	No	-	API field: `display_time_unit`
`dn_bandwidth`	integer	No	-	API field: `dn_bandwidth`
`dynamiclocation_groups`	EntityReferenceWrapperCollection	No	-	API field: `dynamiclocation_groups`
`ec_location`	boolean	No	-	API field: `ec_location`
`exclude_from_dynamic_groups`	boolean	No	-	API field: `exclude_from_dynamic_groups`
`exclude_from_manual_groups`	boolean	No	-	API field: `exclude_from_manual_groups`
`extranet`	EntityReference	No	-	-
`extranet_dns`	EntityReference	No	-	API field: `extranet_dns`
`extranet_ip_pool`	EntityReference	No	-	API field: `extranet_ip_pool`
`geo_override`	boolean	No	-	API field: `geo_override`
`id`	integer	No	-	-
`idle_time_in_minutes`	integer	No	-	API field: `idle_time_in_minutes`
`iot_discovery_enabled`	boolean	No	-	API field: `iot_discovery_enabled`
`iot_enforce_policy_set`	boolean	No	-	API field: `iot_enforce_policy_set`
`ip_addresses`	stringCollection	No	-	API field: `ip_addresses`
`ips_control`	boolean	No	-	API field: `ips_control`
`ipv6_dns64_prefix`	EntityReference	No	-	API field: `ipv6_dns64_prefix`
`ipv6_enabled`	boolean	No	-	API field: `ipv6_enabled`
`jwt_auth`	boolean	No	-	API field: `jwt_auth`
`kerberos_auth`	boolean	No	-	API field: `kerberos_auth`
`language`	string	No	-	-
`latitude`	integer	No	-	-
`longitude`	integer	No	-	-
`managed_by`	EntityReference	No	-	API field: `managed_by`
`match_in_child`	boolean	No	-	API field: `match_in_child`
`multi_tenant_vpn_credential`	VpnCredential	No	-	API field: `multi_tenant_vpn_credential`
`name`	string	No	-	-
`non_editable`	boolean	No	-	API field: `non_editable`
`ofw_enabled`	boolean	No	-	API field: `ofw_enabled`
`other6_sub_location`	boolean	No	-	API field: `other6_sub_location`
`other_sub_location`	boolean	No	-	API field: `other_sub_location`
`override_dn_bandwidth`	integer	No	-	API field: `override_dn_bandwidth`
`override_up_bandwidth`	integer	No	-	API field: `override_up_bandwidth`
`parent_id`	integer	No	-	API field: `parent_id`
`ports`	int32Collection	No	-	-
`profile`	string	No	-	-
`shared_down_bandwidth`	integer	No	-	API field: `shared_down_bandwidth`
`shared_up_bandwidth`	integer	No	-	API field: `shared_up_bandwidth`
`ssl_scan_enabled`	boolean	No	-	API field: `ssl_scan_enabled`
`state`	string	No	-	-
`static_location_groups`	EntityReferenceWrapperCollection	No	-	API field: `static_location_groups`
`sub_loc_acc_ids`	stringCollection	No	-	API field: `sub_loc_acc_ids`
`sub_loc_scope`	string	No	-	API field: `sub_loc_scope`
`sub_loc_scope_enabled`	boolean	No	-	API field: `sub_loc_scope_enabled`
`sub_loc_scope_values`	stringCollection	No	-	API field: `sub_loc_scope_values`
`surrogate_IP`	boolean	No	-	API field: `surrogate_IP`
`surrogate_IP_enforced_for_known_browsers`	boolean	No	-	API field: `surrogate_IP_enforced_for_known_browsers`
`surrogate_refresh_time_in_minutes`	integer	No	-	API field: `surrogate_refresh_time_in_minutes`
`surrogate_refresh_time_unit`	string	No	-	API field: `surrogate_refresh_time_unit`
`traffic_fwd_attributes`	integer	No	-	API field: `traffic_fwd_attributes`
`tz`	string	No	-	-
`unused_dn_bandwidth`	integer	No	-	API field: `unused_dn_bandwidth`
`unused_up_bandwidth`	integer	No	-	API field: `unused_up_bandwidth`
`up_bandwidth`	integer	No	-	API field: `up_bandwidth`
`virtual_zen_clusters`	EntityReferenceWrapperCollection	No	-	API field: `virtual_zen_clusters`
`virtual_zens`	EntityReferenceWrapperCollection	No	-	API field: `virtual_zens`
`vpn_credentials`	VpnCredentialWrapperCollection	No	-	API field: `vpn_credentials`
`xff_forward_enabled`	boolean	No	-	API field: `xff_forward_enabled`
`zapp_ssl_scan_enabled`	boolean	No	-	API field: `zapp_ssl_scan_enabled`

Example

{
  "aup_block_internet_until_accepted": true,
  "aup_enabled": true,
  "aup_force_ssl_inspection": true,
  "aup_timeout_in_days": 123,
  "auth_required": true,
  "authentication_profile": {
    "association_time": 123,
    "deleted": true,
    "extensions": {
      "id": "object-id"
    }
  },
  "basic_auth_enabled": true,
  "bc_location": true
}
// ... more fields

Fields​

Example​

Fields

Example