The following tables describe the relationship between message type and available variable, as well as the corresponding class or interface information in Javadoc.

Tip:

The Javadoc for PingFederate is located in the <pf_install>/pingfederate/sdk/doc directory.

SP connections (SAML 2.0)
Message Types Available Variables

Classes/Interfaces in Javadoc
AssertionType

#AssertionType

org.sourceid.saml20.xmlbinding.assertion.AssertionType

#AssertionTypes

org.sourceid.saml20.xmlbinding.assertion.AssertionType[]

#Attributes

org.sourceid.util.log.AttributeMap
ResponseDocument

#ResponseDocument

org.sourceid.saml20.xmlbinding.protocol.ResponseDocument

#Attributes

org.sourceid.util.log.AttributeMap
SP connections (SAML 1.x)
Message Types Available Variables

Classes/Interfaces in Javadoc
AssertionType

#AssertionType

org.sourceid.protocol.saml11.xml.AssertionType

#AssertionTypes

org.sourceid.protocol.saml11.xml.AssertionType[]

#Attributes

org.sourceid.util.log.AttributeMap
ResponseDocument

#ResponseDocument

org.sourceid.protocol.samlp11.xml.ResponseDocument

#Attributes

org.sourceid.util.log.AttributeMap
SP connections (WS-Federation)
Message Types Available Variables

Classes/Interfaces in Javadoc
AssertionType

#AssertionType

org.sourceid.protocol.saml11.xml.AssertionType

#Attributes

org.sourceid.util.log.AttributeMap
RequestSecurityToken ResponseDocument

#RequestSecurityTokenResponseDocument

org.xmlsoap.schemas.ws.x2005.x02.trust.RequestSecurityTokenResponseDocument

#Attributes

org.sourceid.util.log.AttributeMap
IdP connections (SAML 2.0)
Message Type Available Variables

Classes/Interfaces in Javadoc
AuthnRequestDocument

#AuthnRequestDocument

org.sourceid.saml20.xmlbinding.protocol.AuthnRequestDocument
Other available variables (regardless of roles and protocols)
Available Variables Classes/Interfaces in Javadoc
#XmlHelper com.pingidentity.sdk.xml.XmlHelper
#HttpServletRequest javax.servlet.http.HttpServletRequest
#HttpServletResponse javax.servlet.http.HttpServletResponse
Variables related to Federation Hub (regardless of message type)
Connections Protocol Available Variables

Classes/Interfaces in Javadoc

SP and IdP connections

SAML 2.0

#FedHubIncomingAuthnRequest

org.sourceid.saml20.xmlbinding.protocol.AuthnRequestDocument

SP connection

SAML 2.0

#FedHubOutgoingAuthnRequest

org.sourceid.saml20.xmlbinding.protocol.AuthnRequestDocument

SP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubIncomingAuthnResponse

org.sourceid.saml20.xmlbinding.protocol.ResponseDocument (SAML 20)

org.sourceid.protocol.samlp11.xml.ResponseDocument (SAML 1.x)

org.xmlsoap.schemas.ws.x2005.x02.trust.RequestSecurityTokenResponseDocument (WS-Federation)

SP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubIdpConnPartnerId

java.lang.String

The Partner's Entity ID in the IdP connection that bridges the identity provider.

SP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubIdpConnProtocol

java.lang.String

The protocol of the SP connection. The returned values are SAML20, SAML11, SAML10, or WSFED.

IdP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubSpConnApplicationName

java.lang.String

The application name in the SP connection that bridges the service provider.

IdP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubSpConnName

java.lang.String

The connection name in the SP connection that bridges the service provider.

IdP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubSpConnPartnerId

java.lang.String

The Partner's Entity ID in the SP connection that bridges the service provider.

IdP connection

SAML 2.0

SAML 1.x

WS-Federation

#FedHubSpConnProtocol

java.lang.String

The protocol of the IdP connection. The returned values are SAML20, SAML11, SAML10, or WSFED.

Not applicable

OAuth

#FedHubOAuthClientId

java.lang.String

The client ID in the authorization server that bridges the service provider.

Not applicable

OAuth

#FedHubOAuthClientName

java.lang.String

The client name in the authorization server that bridges the service provider.