No Results
SSO Rule Interface
Article Contents
Method Required Returns Description 
signOn
 Yes void Initiate sign-on. Normally results in a call to ctx.appSession.signOnComplete (either immediately, or in a subsequent subrequest response handler).

The signOn implementation must call one, and only one, of:

  • ctx.appSession.signOnComplete – to indicate the session has either been established or that there is a configuration error.
  • ctx.appSession.signOnAbort – to indicate that a temporal error occurred while trying to establish the session
  • ctx.startSsoRequest – to initiate the start of a sequence of requests required to establish the session.
 
signOff
 Yes void Initiate sign-off. MUST eventually result in a call to ctx.appSession.signOffComplete.

The signOff implementation must call one, and only one, of:

  • ctx.appSession.signOffComplete
  • ctx.startSsxRequest
 
isExpired
 No boolean Examine ctx.appResponse to determine whether session has expired. Return true if session has expired, false if not or unknown.  If true is returned, the session enters the INACTIVE state, and signOn is called to attempt to reestablish the session. 
onRequest
 No void An opportunity to apply any authentication-related modifications to ctx.appRequest. 
onResponse
 No void An opportunity to apply any authentication-related modifications to ctx.clientResponse.

 

Terms | Privacy
×