DeviceOtp

Device Otp resource for Zscaler Client Connector.

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 DeviceOtp
logging.getLogger('zssdk.zcc').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 download_enrolled_devices on DeviceOtp
resource = session.zcc.DeviceOtp()
result = resource.download_enrolled_devices(os_types="value", registration_types="value", stream=False)
print(result)

# Debug output shows HTTP request/response details

Actions

download_enrolled_devices()

Export enrolled devices to CSV

Parameters:

Name	Type	Required	Description
os_types	string	Yes	-
registration_types	string	Yes	-
stream	boolean	No	Pass False to buffer the streamed response in memory and return it as bytes; defaults to True, which returns a StreamingBody for chunked reads.

Example:

resource = session.zcc.DeviceOtp()
result = resource.download_enrolled_devices(os_types="value", registration_types="value", stream=False)
print(result)

force_remove_devices()

Parameters:

Name	Type	Required	Description
page_size	integer	No	-
client_connector_version	stringCollection	Yes	-
os_type	integer	Yes	-
udids	stringCollection	Yes	-
user_name	string	Yes	-

Returns: DeviceRemoveResponse

Example:

resource = session.zcc.DeviceOtp()
result = resource.force_remove_devices(client_connector_version=["value"], os_type=3600, udids=["value"], user_name="example-user-name")
print(result)

get_device_cleanup_info()

Returns: DeviceCleanupInfo

Example:

resource = session.zcc.DeviceOtp()
result = resource.get_device_cleanup_info()
print(result)

get_device_details()

Parameters:

Name	Type	Required	Description
username	string	Yes	-
udid	string	Yes	-

Example:

resource = session.zcc.DeviceOtp()
result = resource.get_device_details(username="example-username", udid="resource-id")
print(result)

get_otp()

Parameters:

Name	Type	Required	Description
udid	string	Yes	-

Returns: DeviceOtp

Example:

resource = session.zcc.DeviceOtp()
result = resource.get_otp(udid="resource-id")
print(result)

remove_devices()

Parameters:

Name	Type	Required	Description
page_size	integer	No	-
client_connector_version	stringCollection	Yes	-
os_type	integer	Yes	-
udids	stringCollection	Yes	-
user_name	string	Yes	-

Returns: DeviceRemoveResponse

Example:

resource = session.zcc.DeviceOtp()
result = resource.remove_devices(client_connector_version=["value"], os_type=3600, udids=["value"], user_name="example-user-name")
print(result)

remove_machine_tunnel_devices()

Parameters:

Name	Type	Required	Description
host_names	stringCollection	Yes	-
machine_token	string	Yes	-

Returns: DeviceRemoveResponse

Example:

resource = session.zcc.DeviceOtp()
result = resource.remove_machine_tunnel_devices(host_names=["example-host-names"], machine_token="value")
print(result)

update_device_cleanup_info()

Parameters:

Name	Type	Required	Description
active	string	No	-
auto_purge_days	string	No	-
auto_removal_days	string	No	-
company_id	string	Yes	-
created_by	string	No	-
device_exceed_limit	string	No	-
edited_by	string	No	-
force_remove_type	string	No	-
force_remove_type_string	string	No	-
id	string	No	-

Returns: StringRecord

Example:

resource = session.zcc.DeviceOtp()
result = resource.update_device_cleanup_info(company_id="resource-id")
print(result)

Attributes

Name	Type	Required	Description
anti_tempering_disable_otp	string	No	-
deception_settings_otp	string	No	-
exit_otp	string	No	-
logout_otp	string	No	-
otp	string	No	-
revert_otp	string	No	-
uninstall_otp	string	No	-
zdp_disable_otp	string	No	-
zdx_disable_otp	string	No	-
zia_disable_otp	string	No	-
zpa_disable_otp	string	No	-
device_otp_array	stringCollection	No	-

Related

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