UserPortal

User Portal resource for Zscaler Private Access.

Resource operations

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 UserPortal
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 UserPortal
resource = session.zpa.UserPortal(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
id	string	Unique identifier

Actions

create()

Creates a new UserPortal. 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	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
enabled	boolean	No	-
description	string	No	-
certificate_id	long	No	-
certificate_name	string	No	-
getc_name	string	No	-
domain	string	No	-
image_data	string	No	-
user_notification	string	No	-
user_notification_enabled	boolean	No	-
inconsistent_config_details	InconsistentConfigDetails	No	-
ext_domain_translation	string	No	-
ext_label	string	No	-
ext_domain	string	No	-
ext_domain_name	string	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.UserPortal()
resource.name = "example-name"
resource.create()
print(f"Created with ID: {resource.id}")

create_user_portal_aup()

Parameters:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
description	string	No	-
enabled	boolean	No	-
aup	string	No	-
email	string	No	-
phone_num	string	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.UserPortal()
result = resource.create_user_portal_aup(name="example-name")
print(result)

create_user_portal_link()

Parameters:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
enabled	boolean	No	-
description	string	No	-
user_portal_id	long	No	-
link	string	No	-
icon_text	string	No	-
protocol	string	No	-
link_path	string	No	-
application_id	long	No	-
user_portals	UserPortalWrapperCollection	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.UserPortal()
result = resource.create_user_portal_link(name="example-name")
print(result)

delete()

Deletes a UserPortal by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
resource.delete()

load()

Fetches an existing UserPortal by id. Only the id identifier is required; load() takes no other arguments.

Returns: UserPortal

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing UserPortal. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
enabled	boolean	No	-
description	string	No	-
certificate_id	long	No	-
certificate_name	string	No	-
getc_name	string	No	-
domain	string	No	-
image_data	string	No	-
user_notification	string	No	-
user_notification_enabled	boolean	No	-
inconsistent_config_details	InconsistentConfigDetails	No	-
ext_domain_translation	string	No	-
ext_label	string	No	-
ext_domain	string	No	-
ext_domain_name	string	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

get_user_portal_link()

Parameters:

Name	Type	Required	Description
customer_id	long	Yes	-
microtenant_id	long	No	-

Returns: UserPortalLink

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
result = resource.get_user_portal_link(customer_id=3600)
print(result)

update_user_portal_link()

Parameters:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
enabled	boolean	No	-
description	string	No	-
user_portal_id	long	No	-
link	string	No	-
icon_text	string	No	-
protocol	string	No	-
link_path	string	No	-
application_id	long	No	-
user_portals	UserPortalWrapperCollection	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
result = resource.update_user_portal_link(name="example-name")
print(result)

delete_user_portal_link()

Parameters:

Name	Type	Required	Description
customer_id	long	Yes	-
microtenant_id	long	No	-

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
result = resource.delete_user_portal_link(customer_id=3600)
print(result)

get_user_portal_aup()

Parameters:

Name	Type	Required	Description
customer_id	long	Yes	-
microtenant_id	long	No	-

Returns: UserPortalAUP

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
result = resource.get_user_portal_aup(customer_id=3600)
print(result)

update_user_portal_aup()

Parameters:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
description	string	No	-
enabled	boolean	No	-
aup	string	No	-
email	string	No	-
phone_num	string	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
result = resource.update_user_portal_aup(name="example-name")
print(result)

delete_user_portal_aup()

Parameters:

Name	Type	Required	Description
customer_id	long	Yes	-
microtenant_id	long	No	-

Example:

resource = session.zpa.UserPortal(id="your-resource-id")
result = resource.delete_user_portal_aup(customer_id=3600)
print(result)

Attributes

Name	Type	Required	Description
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_id	long	No	-
microtenant_name	string	No	-
enabled	boolean	No	-
description	string	No	-
certificate_id	long	No	-
certificate_name	string	No	-
getc_name	string	No	-
domain	string	No	-
image_data	string	No	-
user_notification	string	No	-
user_notification_enabled	boolean	No	-
inconsistent_config_details	InconsistentConfigDetails	No	-
ext_domain_translation	string	No	-
ext_label	string	No	-
ext_domain	string	No	-
ext_domain_name	string	No	-
name_without_trim	string	No	-

Related

• UserPortal - Data structure definition
• Logging guide - enable verbose logs while debugging this resource