AuthSettings

Auth Settings resource for Zscaler Internet Access.

Resource operations

This resource supports the following standard methods: load(), update(). 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 AuthSettings
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 get_auth_settings_lite on AuthSettings
resource = session.zia.AuthSettings()
result = resource.get_auth_settings_lite()
print(result)

# Debug output shows HTTP request/response details

Actions

get_auth_settings_lite()

Parameters:

Name	Type	Required	Description
version	integer	No	-

Returns: AuthSettings

Example:

resource = session.zia.AuthSettings()
result = resource.get_auth_settings_lite()
print(result)

load()

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

Returns: AuthSettings

Example:

resource = session.zia.AuthSettings()
resource.load()
print(resource.auth_frequency)

update()

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

Properties for update:

Name	Type	Required	Description
auth_custom_frequency	integer	No	-
auth_frequency	string	No	-
auto_provision	boolean	No	-
directory_sync_migrate_to_scim_enabled	boolean	Yes	-
kerberos_enabled	boolean	Yes	-
kerberos_pwd	string	Yes	-
last_sync_end_time	integer	No	-
last_sync_start_time	integer	No	-
mobile_admin_saml_idp_enabled	boolean	Yes	-
one_time_auth	string	Yes	-
org_auth_type	string	Yes	-
password_expiry	string	Yes	-
password_strength	string	Yes	-
saml_enabled	boolean	Yes	-

Returns: AuthSettings

Example:

resource = session.zia.AuthSettings(id="your-resource-id")
resource.load()
resource.auth_frequency = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
auth_custom_frequency	integer	No	-
auth_frequency	string	No	-
auto_provision	boolean	No	-
directory_sync_migrate_to_scim_enabled	boolean	Yes	-
kerberos_enabled	boolean	Yes	-
kerberos_pwd	string	Yes	-
last_sync_end_time	integer	No	-
last_sync_start_time	integer	No	-
mobile_admin_saml_idp_enabled	boolean	Yes	-
one_time_auth	string	Yes	-
org_auth_type	string	Yes	-
password_expiry	string	Yes	-
password_strength	string	Yes	-
saml_enabled	boolean	Yes	-

Related

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