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:
| Name | Type | Required | Description |
|---|---|---|---|
include_display_preferences | boolean | No | - |
role | string | No | - |
bypass_IAM | boolean | No | - |
api_key | string | No | - |
password | string | No | - |
provider_name | string | No | - |
saml_response | string | No | - |
timestamp | string | No | - |
username | string | No | - |
Returns: SessionInfo
Example:
resource = session.zia.SessionInfo()
result = resource.create_authenticated_session()
print(result)
create_authenticated_session_internal()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
role | string | No | - |
s_timeout | integer | No | - |
api_key | string | No | - |
password | string | No | - |
provider_name | string | No | - |
saml_response | string | No | - |
timestamp | string | No | - |
username | string | No | - |
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:
| Name | Type | Required | Description |
|---|---|---|---|
include_display_preferences | boolean | No | - |
Returns: SessionInfo
Example:
resource = session.zia.SessionInfo()
result = resource.get_authenticated_session()
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
auth_type | string | Yes | - |
locale | string | No | - |
login_name | string | No | - |
obfuscate_api_key | boolean | Yes | - |
partner_css | string | No | - |
password_expiry_days | integer | Yes | - |
password_expiry_time | long | Yes | - |
read_only | boolean | Yes | - |
source | string | No | - |
sso_dspm_admin_url | string | No | - |
sso_zcc_admin_access | boolean | Yes | - |
sso_zcc_admin_url | string | Yes | - |
sso_zwa_admin_access | boolean | Yes | - |
sso_zwa_admin_url | string | Yes | - |
Related
- SessionInfo - Data structure definition
- Logging guide - enable verbose logs while debugging this resource