Pass Through Authentication

To Configure Pass Through Authentication on existing Web Services, perform the following:

  1. On the Addition Settings page, select the Get Object Required for PTA checkbox.

    • When selected, it executes the Get Object operation to verify if the entered User Name (considered as Identity attribute) is present on the managed system or not.

    • When deselected, it skips the Get Object operation and the Pass Through Authentication operation must have response mapping with account object schema attributes.

  2. (Optional) If user wants to configure error messages for Pass Through Authentication, it can be done using the following entry keys:

    • objectNotFoundErrorMsg

    • authenticationFailedErrorMsg

    • expiredPasswordErrorMsg

    For more information, see Additional Configuration Parameters.
    For example:

    Copy
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:urn="urn:partner.soap.sforce.com">
       <soapenv:Header>
         <urn:LoginScopeHeader>
             <urn:organizationId></urn:organizationId>
             <!--Optional:-->
             <urn:portalId></urn:portalId>
          </urn:LoginScopeHeader>
       </soapenv:Header>
       <soapenv:Body>
          <urn:login>
             <urn:username>$authenticate.username$</urn:username>
             <urn:password>$authenticate.password$</urn:password>
          </urn:login>
       </soapenv:Body>
    </soapenv:Envelope>

Examples

General Information

  1. In the Operation Name field, enter Pass Through Authentication as the operation name.

  2. From the Operation Type drop-down list, select Pass Through Authentication.

  3. In the Authentication URL field, enter the URL specific to the Pass Through Authentication.

  4. In the HTTP Method drop-down list, select POST.

Header and Body

The HTTP body is used for posting the data with a request. The Header has the data keys and their corresponding values. These key value pairs will be sent as part of Header in the HTTP Request.

  1. Under the Header tab, enter the following Key Value pairs:

    • Key = SOAPAction, Value = urn:partner.soap.sforce.com/Soap/queryReq

    • Key = Content-Type, Value = text/xml

  2. Under the Body tab, select the Raw radio button.

  3. In the Body field, enter the XML payload for the Pass Through Authentication.

    The Body has two types, Form Data and Raw. The XML format does not support Form Data.

    Copy
    XML Payload Example
    <soapenv:Envelope xmins:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmins:urn=urn:partner.soap.sforce.com">
        <soapenv:Header>
            <urn:LoginScopeHeader>
                <urn:organizationId></urn:organizationId>
                <urn:portalId></urn:portalId>
            </urn:loginScopeHeader>
        </soapenv:Header>
        <soapenv:Body>
            <urn:login>
                <urn:username>$authenticate.username$</urn:username>
                <urn:password>$authenticate.password$</urn:password>
            </urn:login>
        </soapenv:Body>
    </soapenv:Envelope>

Response Information

The Root Path is the common path present in the JSON response. The Success Code is the successful HTTP response code expected by the respective Web Service operation. By default, the success code is 2**.

  1. In the Root Path field, enter //ns:userInfo

  2. In the Success Code field, enter 2**

Response Mapping

  1. Enter the following Schema Attribute and Attribute Path pairs:

    • Schema Attribute = Username, Attribute Path = ns:userName

    • Schema Attribute = email, Attribute Path = ns:userEmail

    • Schema Attribute = firstName, Attribute Path = ns:firstName

XPath Namespace Mapping

  1. Enter the following Namespace Prefix and Namespace URI pairs:

    • Namespace Prefix = soapenv, Namespace URI = http://schemas.xmlsoap.org/soap/envelope/

    • Namespace Prefix = ns, Namespace URI = urn:partner.soap.sforce.com

    • Namespace Prefix = xsi, Namespace URI = http://www.w3.org/2001/XMLSchema-instance