Skip to main content

SamlAttribute

Saml Attribute resource for Zscaler Private 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 SamlAttribute
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",
)

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

# Debug output shows HTTP request/response details

Identifiers​

NameTypeDescription
idstringUnique identifier

Actions​

create()​

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

Properties for creation:

NameTypeRequiredDescription
customer_idlongNo-
idlongNo-
modified_timeintegerNo-
creation_timeintegerNo-
modified_bylongNo-
namestringYes-
user_attributebooleanNo-
idp_idlongYes-
saml_namestringYes-
idp_namestringNo-
deltastringNo-
name_without_trimstringNo-

Example:

resource = session.zpa.SamlAttribute()
resource.name = "example-name"
resource.idp_id = 3600
resource.saml_name = "example-saml-name"
resource.create()
print(f"Created with ID: {resource.id}")

delete()​

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

Example:

resource = session.zpa.SamlAttribute(id="your-resource-id")
resource.delete()

load()​

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

Returns: SamlAttribute

Example:

resource = session.zpa.SamlAttribute(id="your-resource-id")
resource.load()
print(resource.name)

update()​

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

Properties for update:

NameTypeRequiredDescription
customer_idlongNo-
idlongNo-
modified_timeintegerNo-
creation_timeintegerNo-
modified_bylongNo-
namestringYes-
user_attributebooleanNo-
idp_idlongYes-
saml_namestringYes-
idp_namestringNo-
deltastringNo-
name_without_trimstringNo-

Example:

resource = session.zpa.SamlAttribute(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes​

NameTypeRequiredDescription
idlongNo-
modified_timeintegerNo-
creation_timeintegerNo-
modified_bylongNo-
namestringYes-
user_attributebooleanNo-
idp_idlongYes-
saml_namestringYes-
idp_namestringNo-
deltastringNo-
name_without_trimstringNo-