DomainProfile

Domain Profile 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.

Quick Start

import zssdk
import logging

# Enable debug logging for DomainProfile
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 DomainProfile
resource = session.zia.DomainProfile(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
id	string	Unique identifier

Actions

create()

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

Properties for creation:

Name	Type	Required	Description
custom_domains	stringCollection	No	-
description	string	No	-
include_company_domains	boolean	No	-
include_subdomains	boolean	No	-
predefined_email_domains	PredefinedEmailDomainsEnumCollection	No	-
profile_name	string	Yes	-

Returns: DomainProfile

Example:

resource = session.zia.DomainProfile()
resource.profile_name = "example-profile-name"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

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

Example:

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

load()

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

Returns: DomainProfile

Example:

resource = session.zia.DomainProfile(id="your-resource-id")
resource.load()
print(resource.description)

update()

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

Properties for update:

Name	Type	Required	Description
custom_domains	stringCollection	No	-
description	string	No	-
include_company_domains	boolean	No	-
include_subdomains	boolean	No	-
predefined_email_domains	PredefinedEmailDomainsEnumCollection	No	-
profile_id	integer	Yes	-
profile_name	string	Yes	-

Returns: DomainProfile

Example:

resource = session.zia.DomainProfile(id="your-resource-id")
resource.load()
resource.description = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
custom_domains	stringCollection	No	-
description	string	No	-
include_company_domains	boolean	No	-
include_subdomains	boolean	No	-
predefined_email_domains	PredefinedEmailDomainsEnumCollection	No	-
profile_id	integer	Yes	-
profile_name	string	Yes	-

Related

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