Idp
Idp resource for Zscaler Private Access.
Resource operations
This resource supports the following standard methods: load(). 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 Idp
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 Idp
resource = session.zpa.Idp(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
load()
Fetches an existing Idp by id. Only the id identifier is required; load() takes no other arguments.
Returns: Idp
Example:
resource = session.zpa.Idp(id="your-resource-id")
resource.load()
print(resource.name)
get_scim_attribute()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
scim_attribute_id | long | Yes | - |
Returns: SCIMAttributeHeader
Example:
resource = session.zpa.Idp(id="your-resource-id")
result = resource.get_scim_attribute(customer_id=3600, scim_attribute_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 | - |
certificates | IdpCertCollection | No | - |
login_url | string | No | - |
idp_entity_id | string | No | - |
migration_detail | string | No | - |
description | string | No | - |
auto_provision | integer | No | - |
sign_saml_request | integer | No | - |
login_name_attribute | string | No | - |
sso_type | stringCollection | No | - |
domain_list | stringCollection | No | - |
use_custom_SP_metadata | boolean | No | - |
scim_enabled | boolean | No | - |
scim_shared_secret | string | No | - |
enable_scim_based_policy | boolean | No | - |
disable_saml_based_policy | boolean | No | - |
reauth_on_user_update | boolean | No | - |
user_sp_signing_cert_id | long | No | - |
admin_sp_signing_cert_id | long | No | - |
enable_arbitrary_auth_domains | integer | No | - |
iam_idp_id | string | No | - |
user_metadata | ServiceProvider | No | - |
admin_metadata | ServiceProvider | No | - |
one_identity_enabled | boolean | No | - |
scim_service_provider_endpoint | string | No | - |
scim_shared_secret_exists | boolean | No | - |
force_auth | boolean | No | - |
login_hint | boolean | No | - |
enabled | boolean | No | - |
delta | string | No | - |
redirect_binding | boolean | No | - |
name_without_trim | string | No | - |
encrypt_saml_response | boolean | No | - |
Related
- Idp - Data structure definition
- Logging guide - enable verbose logs while debugging this resource