SAML 2.0 Integration Guide for z-PAX
This guide outlines the steps required to integrate your Identity Provider (IdP) with our SAML 2.0–compliant Service Provider (SP). It covers endpoint configuration, binding requirements, and expected SAML assertion content.
As part of the initial setup, the IdP must provide either a SAML metadata URL or individual SSO/SLO endpoints along with associated X.509/PEM signing certificates. After validation, we will issue a unique [idp-provider-name] identifier for your IdP. This identifier will be embedded in the ACS (Assertion Consumer Service) and metadata URLs.
To work against our development environment, simply replace all instances of api.auth.myzpax.com with sapi.auth.myzpax.com.
SP Details
| Field | Value |
|---|---|
| Entity ID | https://api.auth.myzpax.com/api/saml/ |
| ACS URL | https://api.auth.myzpax.com/api/saml/[idp-provider-name]/callback |
| SAML Binding | HTTP POST |
| NameID Format | urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress |
| Signature Algorithm | RSA-SHA256 (http://www.w3.org/2001/04/xmldsig-more#rsa-sha256) |
| SP Metadata URL | https://api.auth.myzpax.com/api/saml/[idp-provider-name]/metadata |
Signature & Certificate Requirements
-
SAML Responses must be signed
-
Certificates used must:
- Be valid and trusted (issued by a known CA or shared with our team if self-signed for dev)
- Use a minimum of SHA-256 for signature hashing
Required Assertion Attributes
Basic User Attributes
| Attribute Name | Type | Required | Description |
|---|---|---|---|
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname | string | Yes | User’s first name |
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname | string | Yes | User’s last name |
TheNameIDshould contain the user's email address with format:urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
user_inactivity_disable_days Attribute
user_inactivity_disable_days AttributeThis is a single-valued attribute named user_inactivity_disable_days , the value of which indicates how many days of user inactivity (i.e., no SAML login events) are allowed before the user's account should be automatically disabled.
Attribute:
| Name | user_inactivity_disable_days |
| Format | integer |
| Multiplicity | Single |
| Required | Optional |
Example:
<saml:Attribute Name="user_inactivity_disable_days">
<saml:AttributeValue>
30
</saml:AttributeValue>
</saml:Attribute>