PingAM 8.0.0

IDP adapter scripting API

The IDP adapter script is a legacy script and therefore has access to all the legacy common bindings in addition to those described here.
Binding Description

authnRequest

The original authentication request sent from the SP. Not available to the preSendFailureResponse function. Refer to AuthnRequest.

faultCode

The fault code returned in the SAML response.

Only available to the preSendFailureResponse function.

faultDetail

Contains the details of the fault returned in the SAML response.

Only available to the preSendFailureResponse function.

hostedEntityId

The entity ID for the hosted IDP.

idpAdapterScriptHelper

The idpAdapterScriptHelper instance contains supporting methods that provide context information when customizing the IDP adapter plugin points.

Always present.

relayState

A String representing the relayState used in the redirect.

Not available to the preSingleSignOn or preSendFailureResponse functions.

reqId

The id to use for continuation of processing if the adapter redirects.

Not available to the preSignResponse or preSendFailureResponse functions.

request

The HttpServletRequest object. Always present.

res

The SAML response. For information, refer to Response.

Only available to the preSignResponse function.

response

The HttpServletResponse object.

Not available to the preSignResponse function.

session

Not available to the preSingleSignOn or preSendFailureResponse functions.

Contains a representation of the user’s single sign-on session object. Refer to the SSOToken interface for information about SSO token and authentication information, as well as session-related properties.