top

SSO Module

Published 2014-10-28 | (Compatible with SDK 2.5,3.5,4.5,5.0,5.1 and 2011,2012,2013,2014 models)

Enables SSO (Single-Sign On) in applications.

The SSO module includes the following:

Authorization.checkAccount

Checks whether the validity of the account information supplied is valid.

Syntax Authorization.checkAccount(id, password, fnCallback)
Parameter

id: The user ID passed from the Application Manager

password: The user password passed from Application Manager

fnCallback : Callback function that communicates to the Application Manager whether login is successful or not

Return Value None
Remarks Called by the Application Manager. This in turn calls parsebrowserData(fnCallback)
Example
Authorization.checkAccount = function(id, pw, fnCallback) {
    //...
}

parsebrowserData

Sends login information to the service site for validation and retrieves the response.

Syntax receivebrowserXHRResponse(fnCallback)
Parameter func : Callback function
Return Value None
Remarks Called after a response from the service site is received.
Example
function receivebrowserXHRResponse(fnCallback) {
    // Parse response text for authorization token
    // send response to callback function
}

getResponse

Sends callback to the Application Manager.

Syntax getResponse(fnCallback)
Parameter fnCallback : Callback function for triggering
Return Value None
Remarks Communicates to the Application Manager whether the response was a success or a failure through the callback function.

Main.ParseLoginInfo

Parses the URL string sent by the Application Manager and retrieves the id and password of the user pertaining to that application.

Syntax Main.ParseLoginInfo();
Parameter None
Return Value None
Remarks None
Example
Main.ParseLoginInfo = function() {
    var params = window.location.search;
    // Parse string to get data
}