External module "authorization"

Index

Functions

Functions

Const authorizeBySession

authorizeBySession(loginUrl: string, flowKey: string, onAuthenticated: ICallback): void

- Defined in authorization.ts:67
Check the running users authentication (token & url) with a 3rd party service

Parameters
- loginUrl: string
  
  Url of the 3rd party service that the running users session information will be sent to
- flowKey: string
- onAuthenticated: ICallback
  
  Callback with the response from Ajax.sessionAuthentication
Returns void

Const invokeAuthorization

invokeAuthorization(response: any, flowKey: any, onAuthenticated: ICallback): void

- Defined in authorization.ts:32
Redirect to a provided OAuth1, OAuth2 or SAML url, or display the login dialog component

Parameters
- response: any
  
  Response from Ajax.join or Ajax.invoke
- flowKey: any
- onAuthenticated: ICallback
  
  Callback after the running user has successfully authenticated using the Login dialog. This does not get called when authenticated with OAuth2 or SAML.
Returns void

Const isAuthorized

isAuthorized(response: any, flowKey: string): boolean

- Defined in authorization.ts:19
Determine if the running user is authorized based on the response from the platform

Parameters
- response: any
  
  Response from Ajax.initialize, Ajax.join or Ajax.invoke
- flowKey: string
Returns boolean

Generated using TypeDoc