Class default

constructor

• new default(datasource: AuthenticatorDatasource): default

  Constructor for creating an instance of a class with an AuthenticatorDatasource.

  Parameters

  • datasource: AuthenticatorDatasource

    The datasource used for authentication.

  Returns default

  None

isAutheticating

login

• login(
      opts:
          | undefined
          | { email: string; password: string }
          | { callbackUrl?: string; email?: string; optContext?: any },
  ): Promise<undefined | AuthorizationResponse | ErrorResponse>

  Logs in the user using the provided options.

  Parameters

  • opts:
        | undefined
        | { email: string; password: string }
        | { callbackUrl?: string; email?: string; optContext?: any }

    The login options.

    • undefined
    • { email: string; password: string }

      • email: string

        The email of the user.

      • password: string

        The password of the user.
    • { callbackUrl?: string; email?: string; optContext?: any }

      • OptionalcallbackUrl?: string

        The URL to redirect to after login.

      • Optionalemail?: string

        The email of the user.

      • OptionaloptContext?: any

        Additional context information for the login.

  Returns Promise<undefined | AuthorizationResponse | ErrorResponse>

  A promise that resolves with the login response.

loginFederationWithCode

• loginFederationWithCode(
      code: string,
      redirectUrl: string,
  ): Promise<AuthorizationResponse | ErrorResponse>

  Initiates a federation login process with the provided authorization code and redirect URL.

  Parameters

  • code: string

    The authorization code obtained from the federation provider.
  • redirectUrl: string

    The URL to redirect to after the login process.

  Returns Promise<AuthorizationResponse | ErrorResponse>

  A promise that resolves with the response data from the federation login.

loginSSOWithCode

• loginSSOWithCode(code: any): Promise<AuthorizationResponse | ErrorResponse>

  Initiates a Single Sign-On (SSO) login process using the provided code.

  Parameters

  • code: any

    The code required for SSO login.

  Returns Promise<AuthorizationResponse | ErrorResponse>

  A promise that resolves with the response data from the SSO login.

logout

• logout(
      optionalPostLogoutURL?: string,
      keepQueryContext?: boolean,
  ): Promise<boolean>

  Logs out the user from the current session.

  Parameters

  • OptionaloptionalPostLogoutURL: string

    Optional URL to redirect to after logout.
  • OptionalkeepQueryContext: boolean = true

    Flag to determine whether to keep query context.

  Returns Promise<boolean>

  True if logout was successful, false otherwise.

respondToMFAAndLogin

• respondToMFAAndLogin(
      email: string,
      srpId: string,
      context: any,
      code: string,
  ): Promise<AuthorizationResponse | ErrorResponse>

  Responds to Multi-Factor Authentication (MFA) and login challenges for the given email and SRP ID.

  Parameters

  • email: string

    The email address associated with the authentication.
  • srpId: string

    The SRP ID for the authentication challenge.
  • context: any

    The context of the authentication challenge.
  • code: string

    The code for the MFA challenge.

  Returns Promise<AuthorizationResponse | ErrorResponse>

  A promise that resolves with the authentication response.

validate

• validate(
      renewalToken: string,
      email: string,
      forceAPI?: boolean,
      callbackUrl?: string,
      optContext?: any,
  ): Promise<any>

  Parameters

  • renewalToken: string
  • email: string
  • OptionalforceAPI: boolean
  • OptionalcallbackUrl: string
  • OptionaloptContext: any

  Returns Promise<any>