Class AuthenticationService

constructor

• new AuthenticationService(
      configUserProvider: ConfigUserProvider,
  ): AuthenticationService

• Parameters

  • configUserProvider: ConfigUserProvider

  Returns AuthenticationService

config

configUserProvider

userManager

getLoginURL

• getLoginURL(options?: LoginRequestOptions): Promise<string>

• To get the generated login url, call getLoginURL(). This will call authz service and generate login url to be used.

  Parameters

  • Optionaloptions: LoginRequestOptions

    login options to override config settings provided

  Returns Promise<string>

  authz url for login

  Example

  cidaasAuthenticationService.getLoginURL().then(function (response) {
    // the response will give you login url.
  }).catch(function(ex) {
    // your failure code here
  });
  Copy

getUserInfoFromStorage

• getUserInfoFromStorage(): Promise<User>

• To get the user informations from defined UserStorage, call getUserInfoFromStorage(). This will fetch informations about the authenticated user such as tokens & user profiles, which has been stored in predefined user storage based on cidaas configuration. (default is session storage)

  Returns Promise<User>

  returns authenticated user if present, else null

  Example

  cidaasAuthenticationService.getUserInfoFromStorage().then(function (response) {
    // the response will give you profile details.
  }).catch(function(ex) {
    // your failure code here
  });
  Copy

loginCallback

• loginCallback(url?: string): Promise<User>

• Once login successful, it will automatically redirects you to the redirect url, which is configured in cidaas config. To complete the login process, call loginCallback(). This will parses needed informations such as tokens in the redirect url.

  Parameters

  • Optionalurl: string

    optional url to read sign in state from

  Returns Promise<User>

  Example

  cidaasAuthenticationService.loginCallback().then(function (response: User) {
    // the response will give you login details.
  }).catch(function(ex) {
   // your failure code here
  });
  Copy

loginWithBrowser

• loginWithBrowser(options?: LoginRedirectOptions): Promise<void>

• To login through cidaas sdk, call loginWithBrowser(). This will generate and redirect the app to authz url in same window for logging in. Afterwards you will be redirected to the hosted login page. Once login successful, it will automatically redirects you to the redirect url, which is configured in cidaas config.

  Parameters

  • Optionaloptions: LoginRedirectOptions

    to over-ride the client config for redirect login

  Returns Promise<void>

  Example

  cidaasAuthenticationService.loginWithBrowser();
  Copy

logout

• logout(options?: LogoutRedirectOptions): Promise<void>

• To end user session, call logout(). You need set the redirect url, if not it will automatically redirect to the login page

  Parameters

  • Optionaloptions: LogoutRedirectOptions

    optional logout options to override cidaas configuration

  Returns Promise<void>

  Example

  cidaasAuthenticationService.logout();
  Copy

logoutCallback

• logoutCallback(url?: string, keepopen?: boolean): Promise<LogoutResponse>

• logoutCallback() will parses the details of userState after logout. Get the logout call state from the url provided, if none is provided current window url is used.

  Parameters

  • Optionalurl: string

    optional url to read signout state from,
  • Optionalkeepopen: boolean

    optional boolean to keep the popup window open after logout, in case of popupSignOut()

  Returns Promise<LogoutResponse>

  Example

  cidaasAuthenticationService.logoutCallback().then(function (response: LogoutResponse) {
    // the response will give you userState details.
  }).catch(function(ex) {
   // your failure code here
  });
  Copy

popupSignIn

• popupSignIn(options?: PopupSignInOptions): Promise<User>

• To open the hosted login page in pop up window, call popupSignIn(). This will generate and open authz url in a popup window. On successful sign in, authenticated user is returned.

  Parameters

  • Optionaloptions: PopupSignInOptions

    optional options to over-ride the client config for popup sign in

  Returns Promise<User>

  Example

  cidaasAuthenticationService.popupSignIn().then(function (response) {
    // the response will give you user details after finishing loginCallback().
  }).catch(function(ex) {
   // your failure code here
  });
  Copy

popupSignOut

• popupSignOut(options?: PopupSignOutOptions): Promise<void>

• To open the hosted logout page in pop up window, call popupSignOut().

  Parameters

  • Optionaloptions: PopupSignOutOptions

    optional logout options to override cidaas configuration

  Returns Promise<void>

  Example

  cidaasAuthenticationService.popupSignOut().then(function() {
    // success callback in main application window after finishing popupSignOutCallback().
  }).catch(function(ex) {
    // your failure code here
  });
  Copy

registerWithBrowser

• registerWithBrowser(options?: LoginRedirectOptions): Promise<void>

• To register through cidaas sdk, call registerWithBrowser(). This will generate and redirect the app to authz url in same window for register view. Afterwards you will be redirected to the hosted registration page.

  Parameters

  • Optionaloptions: LoginRedirectOptions

    to over-ride the client config for redirect login

  Returns Promise<void>

  Example

  cidaasAuthenticationService.registerWithBrowser();
  Copy

renewToken

• renewToken(options?: RenewTokenOptions): Promise<User>

• renewToken() will update user information in user storage with a new token, based on refresh token that is stored in the storage. On successful token renewal, authenticated user is returned

  Parameters

  • Optionaloptions: RenewTokenOptions

    options to over-ride the client config for renewing token.

  Returns Promise<User>

  Authenticated user

  Example

  cidaasAuthenticationService.renewToken().then(function (response) {
    // the response will give you user details.
  }).catch(function(ex) {
   // your failure code here
  });
  Copy