Skip to main content

Department

Department resource for 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 Department
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 Department
resource = session.zia.Department(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers​

NameTypeDescription
idstringUnique identifier

Actions​

create()​

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

Properties for creation:

NameTypeRequiredDescription
commentsstringNo-
deletedbooleanNo-
idintegerNo-
idp_idlongNo-
is_for_unauthenticated_userbooleanNo-
is_non_editablebooleanNo-
namestringYes-

Returns: Department

Example:

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

delete()​

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

Example:

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

get_department_lite()​

Returns: Department

Example:

resource = session.zia.Department(id="your-resource-id")
result = resource.get_department_lite()
print(result)

load()​

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

Returns: Department

Example:

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

update()​

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

Properties for update:

NameTypeRequiredDescription
commentsstringNo-
deletedbooleanNo-
idintegerNo-
idp_idlongNo-
is_for_unauthenticated_userbooleanNo-
is_non_editablebooleanNo-
namestringYes-

Returns: Department

Example:

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

Attributes​

NameTypeRequiredDescription
commentsstringNo-
deletedbooleanNo-
idintegerNo-
idp_idlongNo-
is_for_unauthenticated_userbooleanNo-
is_non_editablebooleanNo-
namestringYes-