VpnCredential

Vpn Credential resource for Zscaler Internet 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 VpnCredential
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",
)

# Get a specific VpnCredential
resource = session.zia.VpnCredential(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
id	string	Unique identifier

Actions

bulk_delete_vpn_credential()

Parameters:

Name	Type	Required	Description
ids	int32Collection	No	-

Example:

resource = session.zia.VpnCredential()
result = resource.bulk_delete_vpn_credential()
print(result)

create()

Creates a new VpnCredential. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
comments	string	No	-
common_name	string	No	-
disabled	boolean	No	-
fqdn	string	No	-
id	integer	No	-
ip_address	string	No	-
location	EntityReference	No	-
managed_by	EntityReference	No	-
name	string	No	-
pre_shared_key	string	No	-
psk	string	No	-
type	string	No	-
xauth_password	string	No	-

Returns: VpnCredential

Example:

resource = session.zia.VpnCredential()
resource.comments = "value"
resource.common_name = "example-common-name"
resource.disabled = True
resource.create()
print(f"Created with ID: {resource.id}")

delete()

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

Example:

resource = session.zia.VpnCredential(id="your-resource-id")
resource.delete()

load()

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

Returns: VpnCredential

Example:

resource = session.zia.VpnCredential(id="your-resource-id")
resource.load()
print(resource.name)

update()

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

Properties for update:

Name	Type	Required	Description
comments	string	No	-
common_name	string	No	-
disabled	boolean	No	-
fqdn	string	No	-
id	integer	Yes	-
ip_address	string	No	-
location	EntityReference	No	-
managed_by	EntityReference	No	-
name	string	No	-
pre_shared_key	string	No	-
psk	string	No	-
type	string	No	-
xauth_password	string	No	-

Returns: VpnCredential

Example:

resource = session.zia.VpnCredential(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
comments	string	No	-
common_name	string	No	-
disabled	boolean	No	-
fqdn	string	No	-
id	integer	No	-
ip_address	string	No	-
location	EntityReference	No	-
managed_by	EntityReference	No	-
name	string	No	-
pre_shared_key	string	No	-
psk	string	No	-
type	string	No	-
xauth_password	string	No	-

Related

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