ProvisioningKey
Provisioning Key resource for Zscaler Private Access V1.
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 ProvisioningKey
logging.getLogger('zssdk.zpa').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_provisioning_key on ProvisioningKey
resource = session.zpa.ProvisioningKey()
result = resource.create_provisioning_key(name="example-name", enrollment_cert_id=3600)
print(result)
# Debug output shows HTTP request/response details
Actions
create_provisioning_key()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
association_type | string | No | - |
microtenant_id | long | No | - |
id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | long | No | - |
name | string | Yes | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
usage_count | integer | No | - |
max_usage | integer | No | - |
enrollment_cert_id | long | Yes | - |
zcomponent_id | long | No | - |
expiration_in_epoch_sec | integer | No | - |
ip_acl | stringCollection | No | - |
enabled | boolean | No | - |
enrollment_cert_name | string | No | - |
zcomponent_name | string | No | - |
ui_config | string | No | - |
exportable | boolean | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
name_without_trim | string | No | - |
provisioning_key | string | No | - |
Returns: ProvisioningKey
Example:
resource = session.zpa.ProvisioningKey()
result = resource.create_provisioning_key(name="example-name", enrollment_cert_id=3600)
print(result)
delete_provisioning_key()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
association_type | string | Yes | - |
id | long | Yes | - |
microtenant_id | long | No | - |
Example:
resource = session.zpa.ProvisioningKey()
result = resource.delete_provisioning_key(customer_id=3600, association_type="value", id=3600)
print(result)
get_provisioning_key()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
association_type | string | Yes | - |
id | long | Yes | - |
microtenant_id | long | No | - |
Returns: ProvisioningKey
Example:
resource = session.zpa.ProvisioningKey()
result = resource.get_provisioning_key(customer_id=3600, association_type="value", id=3600)
print(result)
update_provisioning_key()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
association_type | string | No | - |
id | long | No | - |
microtenant_id | long | No | - |
id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | long | No | - |
name | string | Yes | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
usage_count | integer | No | - |
max_usage | integer | No | - |
enrollment_cert_id | long | Yes | - |
zcomponent_id | long | No | - |
expiration_in_epoch_sec | integer | No | - |
ip_acl | stringCollection | No | - |
enabled | boolean | No | - |
enrollment_cert_name | string | No | - |
zcomponent_name | string | No | - |
ui_config | string | No | - |
exportable | boolean | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
name_without_trim | string | No | - |
provisioning_key | string | No | - |
Example:
resource = session.zpa.ProvisioningKey()
result = resource.update_provisioning_key(name="example-name", enrollment_cert_id=3600)
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | long | No | - |
name | string | Yes | - |
microtenant_id | long | No | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
usage_count | integer | No | - |
max_usage | integer | No | - |
enrollment_cert_id | long | Yes | - |
zcomponent_id | long | No | - |
expiration_in_epoch_sec | integer | No | - |
ip_acl | stringCollection | No | - |
enabled | boolean | No | - |
enrollment_cert_name | string | No | - |
zcomponent_name | string | No | - |
ui_config | string | No | - |
exportable | boolean | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
name_without_trim | string | No | - |
provisioning_key | string | No | - |
Related
- ProvisioningKey - Data structure definition
- Logging guide - enable verbose logs while debugging this resource