Class MFATicket

MFA Ticket

Constructors

constructor

Accessors

token

Methods

_consume deleteAccount disableAccount disableAuthenticator fetchRecoveryCodes generateAuthenticatorSecret generateRecoveryCodes

Constructors

constructor

  • new MFATicket(
        client: Client,
        ticket: {
            _id: string;
            account_id: string;
            authorised: boolean;
            last_totp_code?: null | string;
            token: string;
            validated: boolean;
        },
        mutate: SetStoreFunction<
            {
                email_mfa?: boolean;
                email_otp?: boolean;
                recovery_active?: boolean;
                security_key_mfa?: boolean;
                totp_mfa?: boolean;
                trusted_handover?: boolean;
            },
        >,
    ): MFATicket

    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)

      • Optionallast_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

Accessors

token

Methods

_consume

deleteAccount

disableAccount

disableAuthenticator

  • disableAuthenticator(): Promise<void>

    Disable authenticator

    Returns Promise<void>

fetchRecoveryCodes

  • fetchRecoveryCodes(): Promise<string[]>

    Fetch recovery codes

    Returns Promise<string[]>

    List of codes

generateAuthenticatorSecret

  • generateAuthenticatorSecret(): Promise<string>

    Generate new authenticator secret

    Returns Promise<string>

    Secret

generateRecoveryCodes

  • generateRecoveryCodes(): Promise<string[]>

    Generate new set of recovery codes

    Returns Promise<string[]>

    List of codes

On This Page

Constructors
Accessors
Methods