Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthClass

Extends oidc-client's UserManager equipped with default configurations, additional simplified methods, and integrated with inactive detector

Hierarchy

  • UserManager
    • AuthClass

Index

Constructors

Accessors

Methods

Constructors

constructor

  • The constructor of the Auth class.

    Parameters

    Returns AuthClass

Accessors

accessTokenExpiredCallback

  • get accessTokenExpiredCallback(): (() => void)

  • Getter for default callback for accessTokenExpired event

    Returns (() => void)

      • (): void

      • Default callback for accessTokenExpired event

        Returns void

accessTokenExpiringCallback

  • get accessTokenExpiringCallback(): (() => Promise<void>)

  • Getter for default callback for accessTokenExpiring event

    Returns (() => Promise<void>)

      • (): Promise<void>

      • Default callback for accessTokenExpiring event

        Returns Promise<void>

options

  • getter function for options property

    Returns AuthConfigs

silentRenewErrorCallback

  • get silentRenewErrorCallback(): (() => void)

  • Getter for default callback for silentRenewError event

    Returns (() => void)

      • (): void

      • Default callback for silentRenewError event.

        Returns void

Methods

getSignedInUser

  • getSignedInUser(): Promise<null | User | Error>

  • Get signed in user by calling AuthManager.getUser()

    Returns Promise<null | User | Error>

renewToken

  • renewToken(): Promise<null | void | User | Error>

  • Renew user's token by calling AuthManager.signInSilent

    Returns Promise<null | void | User | Error>

signIn

  • signIn(destinationPath?: string): Promise<void | Error>

  • Check for signed in user and do signInRedirect if user is not signed in.

    Parameters

    • destinationPath: string = "/"

    Returns Promise<void | Error>

signInRedirectCallback

  • signInRedirectCallback(): Promise<void>

  • To be called in oidc callback page. Redirect user to another page based on AuthManager.signInRedirectCallback result

    Returns Promise<void>

signInSilentCallback

  • signInSilentCallback(): Promise<void>

  • Call AuthManager.signinSilentCallback. To be called inside silentRenewCallback page

    Returns Promise<void>

signOut

  • signOut(): Promise<void>

  • Call AuthManager.signoutRedirect

    Returns Promise<void>

Generated using TypeDoc