A response from firebase.auth.Auth.checkActionCode.

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 the PASSWORD_RESET, VERIFY_EMAIL, and RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to.

For the RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains a previousEmail field with the user account's current email address. After the action completes, the user's email address will revert to the value in the email field from the value in previousEmail field.

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

For the REVERT_SECOND_FACTOR_ADDITION action, which allows a user to unenroll a newly added second factor, this object contains a multiFactorInfo field with the information about the second factor. For phone second factor, the multiFactorInfo is a firebase.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.