LssResource
Lss Resource resource for Private Access.
This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.
Quick Start
import zssdk
import logging
# Enable debug logging for LssResource
logging.getLogger('zssdk.zpa').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)
session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)
# Get a specific LssResource
resource = session.zpa.LssResource(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
add_list_of_portal_links()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
microtenant_id | long | No | - |
user_portal_links | UserPortalLinkBaseWrapperCollection | Yes | - |
user_portals | UserPortalWrapperCollection | No | - |
Example:
resource = session.zpa.LssResource()
result = resource.add_list_of_portal_links(user_portal_links=[{"id": 3600, "modified_time": 3600, "creation_time": 3600, "modified_by": 3600}])
print(result)
create()
Creates a new LssResource. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
id | long | No | - |
config | Lss | Yes | - |
connector_groups | AppConnectorGroupWrapperCollection | No | - |
policy_rule | PolicyRule | No | - |
policy_rule_resource | PolicyRuleResource | No | - |
inconsistent_config_details | InconsistentConfigDetails | No | - |
Example:
resource = session.zpa.LssResource()
resource.config = {"id": 3600, "modified_time": 3600, "creation_time": 3600, "modified_by": 3600}
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a LssResource by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zpa.LssResource(id="your-resource-id")
resource.delete()
get_current_session_details()
Returns: CurrentSessionDetails
Example:
resource = session.zpa.LssResource()
result = resource.get_current_session_details()
print(result)
get_customer_lss_log_format()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
log_type | string | No | - |
Returns: DynamicObject
Example:
resource = session.zpa.LssResource()
result = resource.get_customer_lss_log_format(customer_id=3600)
print(result)
get_inspection_custom_control_types()
Returns: InspectionControlTypesResponse
Example:
resource = session.zpa.LssResource()
result = resource.get_inspection_custom_control_types()
print(result)
get_lss_client_types()
Returns: EmptyModel
Example:
resource = session.zpa.LssResource()
result = resource.get_lss_client_types()
print(result)
get_lss_client_types_for_customer()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
Returns: EmptyModel
Example:
resource = session.zpa.LssResource()
result = resource.get_lss_client_types_for_customer(customer_id=3600)
print(result)
get_lss_log_format()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
log_type | string | No | - |
Returns: DynamicObject
Example:
resource = session.zpa.LssResource()
result = resource.get_lss_log_format()
print(result)
get_status_codes()
Returns: DynamicObject
Example:
resource = session.zpa.LssResource()
result = resource.get_status_codes()
print(result)
load()
Fetches an existing LssResource by id. Only the id identifier is required; load() takes no other arguments.
Returns: LssResource
Example:
resource = session.zpa.LssResource(id="your-resource-id")
resource.load()
print(resource)
update()
Updates an existing LssResource. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
id | long | No | - |
config | Lss | Yes | - |
connector_groups | AppConnectorGroupWrapperCollection | No | - |
policy_rule | PolicyRule | No | - |
policy_rule_resource | PolicyRuleResource | No | - |
inconsistent_config_details | InconsistentConfigDetails | No | - |
Example:
resource = session.zpa.LssResource(id="your-resource-id")
resource.load()
# Modify resource attributes here, then call update()
resource.update()
update_segment_group()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
microtenant_id | long | No | - |
microtenant_name | string | No | - |
name | string | No | - |
description | string | No | - |
enabled | boolean | No | - |
added_apps | int64Collection | No | - |
deleted_apps | int64Collection | No | - |
config_space | string | No | - |
tcp_keep_alive_enabled | integer | No | - |
Example:
resource = session.zpa.LssResource(id="your-resource-id")
result = resource.update_segment_group(customer_id=3600)
print(result)
add_rule_to_policy_set()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
microtenant_id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | string | No | - |
id | string | No | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
action | string | Yes | - |
app_server_groups | AppServerGroupResourceWrapperCollection | No | - |
service_edge_groups | ServiceEdgeGroupRefWrapperCollection | No | - |
app_connector_groups | AppConnectorGroupMinimalWrapperCollection | No | - |
conditions | ConditionSetResourceWrapperCollection | No | - |
extranet_enabled | boolean | No | - |
device_posture_failure_notification_enabled | boolean | No | - |
extranet_DTO | Extranet | No | - |
custom_msg | string | No | - |
description | string | No | - |
reauth_timeout | integer | No | - |
reauth_idle_timeout | integer | No | - |
version | long | No | - |
disabled | integer | No | - |
name | string | Yes | - |
policy_set_id | long | No | - |
rule_order | integer | No | - |
zpn_isolation_profile_id | long | No | - |
priority | integer | No | - |
operator | string | No | - |
policy_type | integer | No | - |
action_id | long | No | - |
zpn_inspection_profile_id | long | No | - |
zpn_inspection_profile_name | string | No | - |
credential | NameId | No | - |
credential_pool | NameId | No | - |
privileged_capabilities | PrivilegedCapabilitiesResource | No | - |
privileged_portal_capabilities | PrivilegedPortalCapabilitiesResource | No | - |
post_actions | PolicyRulePostActions | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
Example:
resource = session.zpa.LssResource(id="your-resource-id")
result = resource.add_rule_to_policy_set(action="value", name="example-name")
print(result)
update_rule_to_policy_set()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
rule_id | long | No | - |
microtenant_id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | string | No | - |
id | string | No | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
action | string | Yes | - |
app_server_groups | AppServerGroupResourceWrapperCollection | No | - |
service_edge_groups | ServiceEdgeGroupRefWrapperCollection | No | - |
app_connector_groups | AppConnectorGroupMinimalWrapperCollection | No | - |
conditions | ConditionSetResourceWrapperCollection | No | - |
extranet_enabled | boolean | No | - |
device_posture_failure_notification_enabled | boolean | No | - |
extranet_DTO | Extranet | No | - |
custom_msg | string | No | - |
description | string | No | - |
reauth_timeout | integer | No | - |
reauth_idle_timeout | integer | No | - |
version | long | No | - |
disabled | integer | No | - |
name | string | Yes | - |
policy_set_id | long | No | - |
rule_order | integer | No | - |
zpn_isolation_profile_id | long | No | - |
priority | integer | No | - |
operator | string | No | - |
policy_type | integer | No | - |
action_id | long | No | - |
zpn_inspection_profile_id | long | No | - |
zpn_inspection_profile_name | string | No | - |
credential | NameId | No | - |
credential_pool | NameId | No | - |
privileged_capabilities | PrivilegedCapabilitiesResource | No | - |
privileged_portal_capabilities | PrivilegedPortalCapabilitiesResource | No | - |
post_actions | PolicyRulePostActions | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
Example:
resource = session.zpa.LssResource(id="your-resource-id")
result = resource.update_rule_to_policy_set(action="value", name="example-name")
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
id | long | No | - |
config | Lss | Yes | - |
connector_groups | AppConnectorGroupWrapperCollection | No | - |
policy_rule | PolicyRule | No | - |
policy_rule_resource | PolicyRuleResource | No | - |
inconsistent_config_details | InconsistentConfigDetails | No | - |
Related
- LssResource - Data structure definition
- Logging guide - enable verbose logs while debugging this resource