Class MFATicket

MFA Ticket

Hierarchy

  • MFATicket

Constructors

constructor

Properties

#client #mutate #ticket #used

Accessors

token

Methods

#consume deleteAccount disableAccount disableAuthenticator fetchRecoveryCodes generateAuthenticatorSecret generateRecoveryCodes

Constructors

constructor

  • Construct MFA Ticket

    Parameters

    • client: Client

      Client

    • ticket: {
          _id: string;
          account_id: string;
          authorised: boolean;
          last_totp_code?: null | string;
          token: string;
          validated: boolean;
      }

      Ticket

      • _id: string

        Description

        Unique Id

      • account_id: string

        Description

        Account Id

      • authorised: boolean

        Description

        Whether this ticket is authorised (can be used to log a user in)

      • Optional last_totp_code?: null | string

        Description

        TOTP code at time of ticket creation

      • token: string

        Description

        Unique Token

      • validated: boolean

        Description

        Whether this ticket has been validated (can be used for account actions)

    • mutate: SetStoreFunction<{
          email_mfa: boolean;
          email_otp: boolean;
          recovery_active: boolean;
          security_key_mfa: boolean;
          totp_mfa: boolean;
          trusted_handover: boolean;
      }>

      Mutate the store

    Returns MFATicket

Properties

Private #client

#client: Client

Private #mutate

#mutate: SetStoreFunction<{
    email_mfa: boolean;
    email_otp: boolean;
    recovery_active: boolean;
    security_key_mfa: boolean;
    totp_mfa: boolean;
    trusted_handover: boolean;
}>

Type declaration

  • email_mfa: boolean
  • email_otp: boolean
  • recovery_active: boolean
  • security_key_mfa: boolean
  • totp_mfa: boolean
  • trusted_handover: boolean

Private #ticket

#ticket: {
    _id: string;
    account_id: string;
    authorised: boolean;
    last_totp_code?: null | string;
    token: string;
    validated: boolean;
}

Type declaration

  • _id: string

    Description

    Unique Id

  • account_id: string

    Description

    Account Id

  • authorised: boolean

    Description

    Whether this ticket is authorised (can be used to log a user in)

  • Optional last_totp_code?: null | string

    Description

    TOTP code at time of ticket creation

  • token: string

    Description

    Unique Token

  • validated: boolean

    Description

    Whether this ticket has been validated (can be used for account actions)

Private #used

#used: boolean = false

Accessors

token

Methods

Private #consume

deleteAccount

  • Delete account

    Returns Promise<undefined>

disableAccount

  • Disable account

    Returns Promise<undefined>

disableAuthenticator

  • Disable authenticator

    Returns Promise<void>

fetchRecoveryCodes

  • Fetch recovery codes

    Returns Promise<string[]>

    List of codes

generateAuthenticatorSecret

  • Generate new authenticator secret

    Returns Promise<string>

    Secret

generateRecoveryCodes

  • Generate new set of recovery codes

    Returns Promise<string[]>

    List of codes

On This Page

Generated using TypeDoc