Type Alias PhoneNumberLogin

Type declaration

• true
• {
      otpLogin?: boolean;
      verificationMessage?: (createCode: () => string) => string;
  }

  • OptionalotpLogin?: boolean

    Enable SMS OTP (one-time password) login for passwordless authentication.

    When enabled, users can sign in by receiving a one-time code via SMS instead of using a password.

    Note: Enabling passwordless login via otpLogin automatically enables the ALLOW_USER_AUTH authentication flow in your Cognito App Client

    Default

    false
    Copy

    Example

    // Enable SMS OTP login
    defineAuth({
      loginWith: {
        phone: {
          otpLogin: true
        }
      }
    })
    Copy

    See

    https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html

  • OptionalverificationMessage?: (createCode: () => string) => string

    The message template for the verification SMS sent to the user upon sign up.

    Default

    // If VerificationEmailStyle.LINK is chosen, verificationMessage will not be configured by default.

    // If VerificationEmailStyle.CODE is chosen, the default function will be as follows: (code) => The verification code to your new account is ${createCode()}