user-facing language code for auth operations that can be internationalized, such as sendEmailVerification(). This language code should follow the conventions defined by the IETF in BCP47.

See also

Applies out of band code. This method will not work for out of band codes which require an additional parameter, such as password reset code.

Parameters

Checks the validity of an out of band code. This code will have been generated by sendPasswordResetEmail or sendEmailVerification

Parameters

Resets the password given a code sent to the user outside of the app and a new password for the user. Code validity can be checked with verifyPasswordResetCode. This use case is only valid for signed-out users, and behavior is undefined for signed-in users. Password changes for signed-in users should be made using FirebaseUser.updatePassword.

Possible error messages:

• Auth.RESULT_AUTH_WEAK_PASSWORD: Indicates an attempt to set a password that is considered too weak.
• Auth.RESULT_AUTH_INVALID_CREDENTIALS: Indicates the administrator disabled sign in with the specified identity provider.
• Auth.RESULT_AUTH_INVALID_ACTION_CODE: Indicates the OOB code is expired OR Indicates the OOB code is invalid.

Parameters

Tries to create a new user account with the given email address and password. If successful, it also signs the user in into the app. Upon successful completion, this operation triggers AuthEvents.AUTH_STATE_CHANGED

Important: you must enable Email and Password accounts in the Firebase console before you can use this method.

Possible error messages:

• Auth.RESULT_AUTH_WEAK_PASSWORD: thrown if the password is not strong enough
• Auth.RESULT_AUTH_INVALID_CREDENTIALS: thrown if the email address is malformed
• Auth.RESULT_AUTH_USER_COLLISION: thrown if there already exists an account with the given email address

Parameters

Deprecated, use fetchSignInMethodsForEmail instead.

Dispatches a list of authentication providers that can be used to sign in a given user (identified by its main email address). This method is useful when you support multiple authentication mechanisms if you want to implement an email-first authentication flow. It is also useful to resolve a Auth.RESULT_AUTH_USER_COLLISION thrown on signIn(_authProvider.getCredential()).

Possible error messages:

• Auth.RESULT_AUTH_INVALID_CREDENTIALS: thrown if the email address is malformed

Parameters

Returns a list of signin methods that can be used to sign in a given user (identified by its main email address). This method is useful when you support multiple authentication mechanisms if you want to implement an email-first authentication flow. It is also useful to resolve a Auth.RESULT_AUTH_USER_COLLISION thrown on signIn(_authProvider.getCredential()).

Possible error messages:

• Auth.RESULT_AUTH_INVALID_CREDENTIALS: thrown if the email address is malformed

Parameters

Call this method prior to any other Auth methods.

Parameters

Android only If your app is closed before the phone auth progress is finished, you should use this method to get back in the progress. Use this property to know: isPhoneVerificationInProgress

If you have already received the verificationId by the AuthEvents.PHONE_CODE_SENT listener, you can simply use the sms code and the verificationId to sign in the user with the signIn method. on iOS, the ANE can't read the sms code automatically. So, when it is received, you should login the user like the following sample.

Parameters

         // create a new authProvider object first
         var authProvider:AuthProvider = new AuthProvider();
                  // decide what kind of credential this authProvider instance will hold
         authProvider.setPhoneAuthProvider("verificationId_received_with_PHONE_CODE_SENT", "SMS_CODE");
                  // finally feed in the Auth.signIn method with the parsed credential info from the authProvider instance.
         Auth.signIn(authProvider.getCredential());
         

Triggers the Firebase Authentication backend to send a password-reset email to the given email address, which must correspond to an existing user of your app. Optinally Takes in an ActionCodeSettings which allows linking back to your app from the sent email.

Possible error messages:

• Auth.RESULT_AUTH_INVALID_USER: Thrown if there is no user corresponding to the given email address.

Parameters

Sends an email to the specified email which will contain a link to be used to sign in the user.

Parameters

Tries to sign in a user with the given credential info. Use this method to sign in a user into your Firebase Authentication system. First retrieve the credential either directly from the user, in case of AuthProvider.EMAIL, or from a supported authentication SDK, such as Google Sign-In or Facebook.

To sign in a user a anonymously, simply pass null when calling this method.

NOTICE: THIS FEATURE IS ONLY AVAILABLE TO MYFLASHLABS CLUB MEMBERS. If you are a club member, you can signin users with other AuthProviders like Facebook, Twitter, Google, Github and Apple rather than simple email/pass authentication through Firebase. This is good enough for most cases. However by Joining the club, you are supporting the MyFlashLabs Team to be able to do their job with more ease.

For all credential types except AuthProvider.EMAIL, this method will create an account for the user in the case that it didn't exist before.

Important: you must configure the authentication providers in the Firebase console before you can use them.

Possible error messages:

• Auth.RESULT_AUTH_INVALID_USER: Thrown if the user account you are trying to sign in to has been disabled. Also thrown if credential is an AuthProvider.EMAIL with an email address that does not correspond to an existing user.
• Auth.RESULT_AUTH_INVALID_CREDENTIALS: Thrown if the credential is malformed or has expired. If credential instanceof AuthProvider.EMAIL it will be thrown if the password is incorrect.
• Auth.RESULT_AUTH_USER_COLLISION: Thrown if there already exists an account with the email address asserted by the credential. Resolve this case by calling fetchProvidersForEmail() and then asking the user to sign in using one of them.

Parameters

Asynchronously signs in to Firebase with the given Auth token.

Possible error messages:

• Auth.RESULT_AUTH_INVALID_USER: Indicates a validation error with the custom token OR Indicates the service account and the API key belong to different projects.

Parameters

Deprecated, use signInWithEmailPass instead.

Parameters

Tries to sign in a user with the given email address and link. This link should be generated by Auth.sendSignInLinkToEmail(String, ActionCodeSettings).

Important: you must enable Passwordless sign-in in the Firebase console before being able to use this method.

Possible error messages:

• Auth.RESULT_AUTH_INVALID_CREDENTIALS
• Auth.RESULT_AUTH_INVALID_USER

Parameters

Signs in using an email address and password.

Possible error messages:

• Auth.RESULT_AUTH_INVALID_CREDENTIALS: Indicates the email address is malformed OR Indicates the user attempted sign in with an incorrect password OR indicates that email and password accounts are not enabled. Enable them in the Auth section of the Firebase console.
• Auth.RESULT_AUTH_INVALID_USER: Indicates the user's account is disabled.

Parameters

Signs out the current user and clears it from the disk cache. Upon successful completion, this operation triggers AuthEvents.AUTH_STATE_CHANGED

Sets the user-facing language code to be the default app language.

See also

Checks the validity of a verify password reset code.

Parameters

Starts the phone number verification process for the given phone number. Either sends an SMS with a 6 digit code to the phone number specified or triggers PHONE_VERIFICATION_RESULT that can be used to log in the user.

Parameters

Action code for password reset operation

Action code for unknown operation

Action code for verify email operation

Represents the exception which is a result of an attempt to send an email via Firebase Auth (e.g. a password reset email)

Thrown when one or more of the credentials passed to a method fail to identify and/or authenticate the user subject of that operation. Inspect the error code and message to find out the specific cause.

Thrown when performing an operation on a FirebaseUser instance that is no longer valid.

This could happen in the following cases:

• ERROR_USER_DISABLED if the user has been disabled (for example, in the Firebase console)
• ERROR_USER_NOT_FOUND if the user has been deleted (for example, in the Firebase console, or in another instance of this app)
• ERROR_USER_TOKEN_EXPIRED if the user's token has been revoked in the backend. This happens automatically if the user's credentials change in another device (for example, on a password change event).
• ERROR_INVALID_USER_TOKEN if the user's token is malformed. This should not happen under normal circumstances.

You should consider this error condition as if the user had signed out of your app, and thus should require them to sign in again if they need to perform any action that requires authentication.

(iOS) Raised when a JWT fails to parse correctly. May be accompanied by an underlying error describing which step of the JWT parsing process failed.

Deprecated. please use RESULT_AUTH_RECENT_LOGIN_REQUIRED instead.

Thrown on security sensitive operations on a FirebaseUser instance that require the user to have signed in recently, when the requirement isn't met.

Resolve this exception by asking the user for their credentials again.

Thrown when an operation on a FirebaseUser instance couldn't be completed due to a conflict with another existing user.

This could happen in the following cases:

• ERROR_EMAIL_ALREADY_IN_USE when trying to create a new account with createUserWithEmailAndPassword() or to change a user's email address, if the email is already in use by a different account
• ERROR_ACCOUNT_EXISTS_WITH_DIFFERENT_CREDENTIAL when calling signInWithCredential() with a credential that asserts an email address in use by another account. This error will only be thrown if the "One account per email address" setting is enabled in the Firebase console (recommended).
• ERROR_CREDENTIAL_ALREADY_IN_USE when trying to link a user with an AuthCredential corresponding to another account already in use

Resolve this exception by asking the user to sign in again with valid credentials.

Thrown when using a weak password (less than 6 chars) to create a new account or to update an existing account's password.

Thrown when there is an error unrelated to Firebase library directly.

(iOS) Represents the error code for when the given provider id for a web operation is invalid.

Indicates that the operation has been successfull.

Exception thrown when a request to a Firebase service has been blocked due to having received too many consecutive requests from the same device. Retry the request later to resolve.