Type Alias EmailLoginSettings

Type declaration

• VerificationEmailWithLink
• VerificationEmailWithCode

• OptionalotpLogin?: boolean

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

  When enabled, users can sign in by receiving a one-time code via email 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 email OTP login
  defineAuth({
    loginWith: {
      email: {
        otpLogin: true
      }
    }
  })
  Copy

  See

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

• OptionaluserInvitation?: {
      emailBody?: (username: () => string, code: () => string) => string;
      emailSubject?: string;
      smsMessage?: (username: () => string, code: () => string) => string;
  }

  Customize the email invitation sent to users when an administrators signs them up.

  • OptionalemailBody?: (username: () => string, code: () => string) => string

    The template to the email body that is sent to the user when an administrator signs them up to the user pool.

    Default

    (username, code) => 'Your username is {username()} and temporary password is {code()}.'
    Copy

  • OptionalemailSubject?: string

    The template to the email subject that is sent to the user when an administrator signs them up to the user pool.

    Default

    'Your temporary password'
    Copy

  • OptionalsmsMessage?: (username: () => string, code: () => string) => string

    The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

    Default

    (username, code) => 'Your username is {username()} and temporary password is {code()}.'
    Copy