Type alias Factor<Type, Status>

Factor<Type, Status>: {
    created_at: string;
    factor_type: Type;
    friendly_name?: string;
    id: string;
    status: Status;
    updated_at: string;
}

A MFA factor.

See

Type Parameters

  • Type extends FactorType = FactorType

  • Status extends FactorVerificationStatus = typeof FactorVerificationStatuses[number]

Type declaration

  • created_at: string
  • factor_type: Type

    Type of factor. totp and phone supported with this version

  • Optional friendly_name?: string

    Friendly name of the factor, useful to disambiguate between multiple factors.

  • id: string

    ID of the factor.

  • status: Status

    The verification status of the factor, default is unverified after .enroll(), then verified after the user verifies it with .verify()

  • updated_at: string

Settings

Member Visibility

Theme

Generated using TypeDoc