Index

Type aliases

Properties

Variables

Type aliases

Operation

Operation:string

Properties

data

data:{email?:string |null;fromEmail?:string |null;multiFactorInfo?:MultiFactorInfo |null;previousEmail?:string |null }

The data associated with the action code.

For thePASSWORD_RESET,VERIFY_EMAIL, andRECOVER_EMAIL actions, this objectcontains anemail field with the address the email was sent to.

For the RECOVER_EMAIL action, which allows a user to undo an email addresschange, this object also contains apreviousEmail field with the user account'scurrent email address. After the action completes, the user's email address willrevert to the value in theemail field from the value inpreviousEmail field.

For the VERIFY_AND_CHANGE_EMAIL action, which allows a user to verify the emailbefore updating it, this object contains apreviousEmail field with the useraccount's email address before updating. After the action completes, the user'semail address will be updated to the value in theemail field from the valueinpreviousEmail field.

For the REVERT_SECOND_FACTOR_ADDITION action, which allows a user to unenrolla newly added second factor, this object contains amultiFactorInfo field withthe information about the second factor. For phone second factor, themultiFactorInfo is afirebase.auth.PhoneMultiFactorInfo object,which contains the phone number.

Type declaration

  • Optional email?:string |null
  • Optional fromEmail?:string |null
    deprecated

    This field is deprecated in favor of previousEmail.

  • Optional multiFactorInfo?:MultiFactorInfo |null
  • Optional previousEmail?:string |null

operation

operation:string

The type of operation that generated the action code. This could be:

Variables

Operation

Operation:{EMAIL_SIGNIN:Operation;PASSWORD_RESET:Operation;RECOVER_EMAIL:Operation;REVERT_SECOND_FACTOR_ADDITION:Operation;VERIFY_AND_CHANGE_EMAIL:Operation;VERIFY_EMAIL:Operation }

An enumeration of the possible email action types.

Type declaration

  • EMAIL_SIGNIN:Operation

    The email link sign-in action.

  • PASSWORD_RESET:Operation

    The password reset action.

  • RECOVER_EMAIL:Operation

    The email revocation action.

  • REVERT_SECOND_FACTOR_ADDITION:Operation

    The revert second factor addition email action.

  • VERIFY_AND_CHANGE_EMAIL:Operation

    The verify and update email action.

  • VERIFY_EMAIL:Operation

    The email verification action.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-27 UTC.