AgileApps Support Wiki

Difference between revisions of "Pass Through Authentication"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 8: Line 8:


The URL of the Authentication Server and the <!--default -->URLs of the pages to visit in the event of success or failure are configured in the platform's [[Single Sign-On]] Settings.<!-- The destination URLs can be overridden dynamically, by the application.-->
The URL of the Authentication Server and the <!--default -->URLs of the pages to visit in the event of success or failure are configured in the platform's [[Single Sign-On]] Settings.<!-- The destination URLs can be overridden dynamically, by the application.-->
{{#if: | UNCOMMENT THE NOTES HERE AND BELOW WHEN OVERRIDES ARE IMPLEMENTED.}}


====Actions====
====Actions====
Line 43: Line 44:
#Fill in the Pass Through Authentication Settings:
#Fill in the Pass Through Authentication Settings:
#:;Third party Authentication Service URL: Location of the authentication service. The platform uses this URL to authenticate the USER, passing the appropriate pay load in the HTTP request.
#:;Third party Authentication Service URL: Location of the authentication service. The platform uses this URL to authenticate the USER, passing the appropriate pay load in the HTTP request.
#:;Success page URL: The <!--default -->page the platform sends the user to when authentication succeeds.<!-- (Can be overridden dynamically in the HTTP request.) -->
#:;Success page URL: The page the platform sends the user to when authentication succeeds.<br>If not specified, the default destination is the platform's home page.<!-- (Can be overridden dynamically in the HTTP request.) -->
#:;Error page URL: The <!--default -->page the platform sends the user to when authentication fails.<br>The default destination is the platform’s Login-error page.<!-- (Can be overridden dynamically in the HTTP request.) -->
#:;Error page URL: The page the platform sends the user to when authentication fails.<br>If not specified, the default destination is the platform’s Login-error page.<!-- (Can be overridden dynamically in the HTTP request.) -->
#Click '''[Save]'''
#Click '''[Save]'''
{{#if: | UNCOMMENT THE NOTES ABOVE WHEN OVERRIDES ARE IMPLEMENTED.}}


===Message Formats===
===Message Formats===


===Initial Message Sent to the Platform===
====Initial Message Sent to the Platform====
This message format needs to be delivered to the platform by the Application or web page.
This message format needs to be delivered to the platform by the Application or web page.


:* Method: POST
;Method:POST  
 
;URI:<tt><nowiki>https://{domain}/networking/passThroughAuth</nowiki></tt>
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<LJAuthenticate xmlns="urn:authentication.soap.ws.longjump.com">
<sessionID>...</sessionID>
<loginID>...</loginID>
</LJAuthenticate>
</soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>


===Messages Sent Between the Platform and Authentication Server===
where:
:;sessionID:The session ID of the user on the organization's website. Optional. It is passed on to the authentication service, so the authentication service can make use of it.
:;loginID: The user's login name on the platform--typically in the form of an emails address.
 
 
====Messages Sent Between the Platform and Authentication Server====
These message formats need to be processed and/or delivered by the Authentication Server.
These message formats need to be processed and/or delivered by the Authentication Server.


Revision as of 21:35, 17 August 2011

Pass Through Authentication (PTA) lets a user go straight to the platform from an organization's web page or application, without having to log in again.

How it Works

As part of an enterprise application, the user would like to visit a page hosted on the platform, without having to log in to the platform to see it. To accomplish that goal, the application sends a small SOAP message to the platform, in an HTTP request.

That message contains the information needed to log into the platform. Data in it is passed to an authentication server, which sends back a message saying that authentication has succeeded or failed, after which the user is directed to the appropriate page.

The URL of the Authentication Server and the URLs of the pages to visit in the event of success or failure are configured in the platform's Single Sign-On Settings.


Actions

User... Platform... Your Organization's Web Service...
1. Provides a web page or application
2. Visits the page or application
3. Clicks a link to go to a platform page
4. Passes data to the platform's PTA service in the SOAP payload
5.
  • Receives data in the SOAP payload:
  • Session ID (optional, but desirable)
  • Login ID
  • Passes data to the Authentication server
6. Receives a success- or failure-report from the Authentication Server
7. Redirects the user to the appropriate page.

Enabling Pass Through Authentication

  1. Click Settings > Administration > Single Sign-On
  2. Click the [Edit] button
  3. For Single Sign-On Settings, choose Pass Through Authentication
  4. Fill in the Pass Through Authentication Settings:
    Third party Authentication Service URL
    Location of the authentication service. The platform uses this URL to authenticate the USER, passing the appropriate pay load in the HTTP request.
    Success page URL
    The page the platform sends the user to when authentication succeeds.
    If not specified, the default destination is the platform's home page.
    Error page URL
    The page the platform sends the user to when authentication fails.
    If not specified, the default destination is the platform’s Login-error page.
  5. Click [Save]

Message Formats

Initial Message Sent to the Platform

This message format needs to be delivered to the platform by the Application or web page.

Method
POST
URI
https://{domain}/networking/passThroughAuth
<?xml version="1.0" encoding="UTF-8" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Body>
		<LJAuthenticate xmlns="urn:authentication.soap.ws.longjump.com">
			<sessionID>...</sessionID>
			<loginID>...</loginID>
		</LJAuthenticate>
	</soapenv:Body>
</soapenv:Envelope>

where:

sessionID
The session ID of the user on the organization's website. Optional. It is passed on to the authentication service, so the authentication service can make use of it.
loginID
The user's login name on the platform--typically in the form of an emails address.


Messages Sent Between the Platform and Authentication Server

These message formats need to be processed and/or delivered by the Authentication Server.

Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Pass_Through_Authentication&oldid=14792"