Skip to main content

SessionInfo

Session Info resource for Internet Access.

Resource operations

This resource does not support standard CRUDL methods. Each 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 SessionInfo
logging.getLogger('zssdk.zia').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",
)

# Call create_authenticated_session on SessionInfo
resource = session.zia.SessionInfo()
result = resource.create_authenticated_session()
print(result)

# Debug output shows HTTP request/response details

Actions​

create_authenticated_session()​

Parameters:

NameTypeRequiredDescription
include_display_preferencesbooleanNo-
rolestringNo-
bypass_IAMbooleanNo-
api_keystringNo-
passwordstringNo-
provider_namestringNo-
saml_responsestringNo-
timestampstringNo-
usernamestringNo-

Returns: SessionInfo

Example:

resource = session.zia.SessionInfo()
result = resource.create_authenticated_session()
print(result)

create_authenticated_session_internal()​

Parameters:

NameTypeRequiredDescription
rolestringNo-
s_timeoutintegerNo-
api_keystringNo-
passwordstringNo-
provider_namestringNo-
saml_responsestringNo-
timestampstringNo-
usernamestringNo-

Returns: ZdxAuthInfo

Example:

resource = session.zia.SessionInfo()
result = resource.create_authenticated_session_internal()
print(result)

delete_authenticated_session()​

Returns: ZManageAPIResponse

Example:

resource = session.zia.SessionInfo()
result = resource.delete_authenticated_session()
print(result)

get_authenticated_session()​

Parameters:

NameTypeRequiredDescription
include_display_preferencesbooleanNo-

Returns: SessionInfo

Example:

resource = session.zia.SessionInfo()
result = resource.get_authenticated_session()
print(result)

Attributes​

NameTypeRequiredDescription
auth_typestringYes-
localestringNo-
login_namestringNo-
obfuscate_api_keybooleanYes-
partner_cssstringNo-
password_expiry_daysintegerYes-
password_expiry_timelongYes-
read_onlybooleanYes-
sourcestringNo-
sso_dspm_admin_urlstringNo-
sso_zcc_admin_accessbooleanYes-
sso_zcc_admin_urlstringYes-
sso_zwa_admin_accessbooleanYes-
sso_zwa_admin_urlstringYes-