A response fromfirebase.auth.Auth.checkActionCode.
Index
Type aliases
Operation
Properties
data
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 from
Email?:string |null - deprecated
This field is deprecated in favor of previousEmail.
Optional multi
Factor Info?:MultiFactorInfo |null Optional previous
Email?:string |null
operation
The type of operation that generated the action code. This could be:
- `EMAIL_SIGNIN`: email sign in code generated viafirebase.auth.Auth.sendSignInLinkToEmail.
- `PASSWORD_RESET`: password reset code generated viafirebase.auth.Auth.sendPasswordResetEmail.
- `RECOVER_EMAIL`: email change revocation code generated viafirebase.User.updateEmail.
- `REVERT_SECOND_FACTOR_ADDITION`: revert second factor additioncode generated viafirebase.User.MultiFactorUser.enroll.
- `VERIFY_AND_CHANGE_EMAIL`: verify and change email code generatedviafirebase.User.verifyBeforeUpdateEmail.
- `VERIFY_EMAIL`: email verification code generated viafirebase.User.sendEmailVerification.
Variables
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.