Docs

SignInSecondFactor

The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.

type SignInSecondFactor =
  | PhoneCodeFactor
  | TOTPFactor
  | BackupCodeFactor;
  • Name
    strategy
    Type
    string
    Description

    The strategy of the factor.
    Supports the following values:

    • "phone_code"
    • "totp"
    • "backup_code"

  • Name
    phoneNumberId
    Type
    string
    Description

    The ID of the phone number that a code will be sent to. Populated when the strategy is "phone_code".

  • Name
    safeIdentifier
    Type
    string
    Description

    The safe identifier of the factor.
    Supports the following values:

    • "phoneNumber"

    Populated when the strategy is "phone_code".

  • Name
    primary
    Type
    boolean
    Description

    Whether the factor is the primary factor.
    Populated when the strategy is "phone_code".

type TOTPFactor = {
  strategy: TOTPStrategy;
};
type BackupCodeFactor = {
  strategy: BackupCodeStrategy;
};

Feedback

What did you think of this content?