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

Binding	Description
`authnRequest`	The original authentication request from the SP. For details, refer to AuthnRequest. Not available to the `preSendFailureResponse` function.
`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`	An object with methods to provide context when customizing the IdP adapter plugin points. For details, refer to IdpAdapterScriptHelper. Always present.
`relayState`	A String representing the `relayState` used in the redirect. Not available to the `preSingleSignOn` or `preSendFailureResponse` functions.
`reqId`	The identifier to continue processing if the adapter redirects. Not available to the `preSignResponse` or `preSendFailureResponse` functions.
`request`	The `HttpServletRequest` object. Always present.
`res`	The SAML response. For details, refer to Response. Only available to the `preSignResponse` function.
`response`	The `HttpServletResponse` object. Not available to the `preSignResponse` function.
`session`	Represents the user’s single sign-on session object. For details, refer to SSOToken. Not available to the `preSingleSignOn` or `preSendFailureResponse` functions.

authnRequest

The original authentication request from the SP. For details, refer to AuthnRequest.

Not available to the preSendFailureResponse function.

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

An object with methods to provide context when customizing the IdP adapter plugin points. For details, refer to IdpAdapterScriptHelper.

Always present.

relayState

A String representing the relayState used in the redirect.

Not available to the preSingleSignOn or preSendFailureResponse functions.

reqId

The identifier to continue processing if the adapter redirects.

Not available to the preSignResponse or preSendFailureResponse functions.

request

The HttpServletRequest object. Always present.

res

The SAML response. For details, refer to Response.

Only available to the preSignResponse function.

response

The HttpServletResponse object.

Not available to the preSignResponse function.

session

Represents the user’s single sign-on session object. For details, refer to SSOToken.

Not available to the preSingleSignOn or preSendFailureResponse functions.