Firebase.Auth

Summary

Enumerations

AuthError{
  None = 0,
  Unimplemented = -1,
  Failure = 1,
  InvalidCustomToken,
  CustomTokenMismatch,
  InvalidCredential,
  UserDisabled,
  AccountExistsWithDifferentCredentials,
  OperationNotAllowed,
  EmailAlreadyInUse,
  RequiresRecentLogin,
  CredentialAlreadyInUse,
  InvalidEmail,
  WrongPassword,
  TooManyRequests,
  UserNotFound,
  ProviderAlreadyLinked,
  NoSuchProvider,
  InvalidUserToken,
  UserTokenExpired,
  NetworkRequestFailed,
  InvalidApiKey,
  AppNotAuthorized,
  UserMismatch,
  WeakPassword,
  NoSignedInUser,
  ApiNotAvailable,
  ExpiredActionCode,
  InvalidActionCode,
  InvalidMessagePayload,
  InvalidPhoneNumber,
  MissingPhoneNumber,
  InvalidRecipientEmail,
  InvalidSender,
  InvalidVerificationCode,
  InvalidVerificationId,
  MissingVerificationCode,
  MissingVerificationId,
  MissingEmail,
  MissingPassword,
  QuotaExceeded,
  RetryPhoneAuth,
  SessionExpired,
  AppNotVerified,
  AppVerificationFailed,
  CaptchaCheckFailed,
  InvalidAppCredential,
  MissingAppCredential,
  InvalidClientId,
  InvalidContinueUri,
  MissingContinueUri,
  KeychainError,
  MissingAppToken,
  MissingIosBundleId,
  NotificationNotForwarded,
  UnauthorizedDomain,
  WebContextAlreadyPresented,
  WebContextCancelled
}
enum
All possible error codes from asynchronous calls.

Classes

Firebase.Auth.AdditionalUserInfo

Additional user data returned from an identity provider.

Firebase.Auth.Credential

Authentication credentials for an authentication provider.

Firebase.Auth.EmailAuthProvider

Use email and password to authenticate.

Firebase.Auth.FacebookAuthProvider

Use an access token provided by Facebook to authenticate.

Firebase.Auth.FirebaseAuth

Firebase authentication object.

Firebase.Auth.FirebaseUser

Firebase user account object.

Firebase.Auth.ForceResendingToken

Token to maintain current phone number verification session.

Firebase.Auth.GitHubAuthProvider

Use an access token provided by GitHub to authenticate.

Firebase.Auth.GoogleAuthProvider

Use an ID token and access token provided by Google to authenticate.

Firebase.Auth.OAuthProvider

OAuth2.0+UserInfo auth provider (OIDC compliant and non-compliant).

Firebase.Auth.PhoneAuthProvider

Use phone number text messages to authenticate.

Firebase.Auth.PlayGamesAuthProvider

Use a server auth code provided by Google Play Games to authenticate.

Firebase.Auth.SignInResult

Result of operations that can affect authentication state.

Firebase.Auth.TwitterAuthProvider

Use a token and secret provided by Twitter to authenticate.

Firebase.Auth.UserMetadata

Metadata corresponding to a Firebase user.

Firebase.Auth.UserProfile

Parameters to the UpdateUserProfile() function.

Interfaces

Firebase.Auth.IUserInfo

Interface implemented by each identity provider.

Enumerations

AuthError

 AuthError

All possible error codes from asynchronous calls.

For error details, use the FirebaseException.Message property.

Properties
AccountExistsWithDifferentCredentials

Indicates an account already exists with the same email address but using different sign-in credentials.

Account linking is required. Caused by "Sign in with credential" methods.

ApiNotAvailable

This can happen when certain methods on App are performed, when the auth API is not loaded.

Note:This error is only reported on Android.

AppNotAuthorized

Indicates the App is not authorized to use Firebase Authentication with the provided API Key.

Common error code for all API Methods. On Android this error should no longer occur (as of 2016 v3). Common error code for all API Methods.

AppNotVerified

Indicates that the app could not be verified by Firebase during phone number authentication.

Note:This error is iOS-specific.

AppVerificationFailed

Indicates a general failure during the app verification flow.

Note:This error is iOS-specific.

CaptchaCheckFailed

Indicates that the reCAPTCHA token is not valid.

Note:This error is iOS-specific.

CredentialAlreadyInUse

Indicates an attempt to link with a credential that has already been linked with a different Firebase account.

Caused by "Set account info" methods.

CustomTokenMismatch

Indicates the service account and the API key belong to different projects.

Caused by "Bring your own auth" methods.

EmailAlreadyInUse

Indicates the email used to attempt a sign up is already in use.

Caused by "Set account info" methods.

ExpiredActionCode

Indicates the out-of-band authentication code is expired.

Failure

This indicates an internal error.

Common error code for all API Methods.

InvalidActionCode

Indicates the out-of-band authentication code is invalid.

InvalidApiKey

Indicates an invalid API key was supplied in the request.

For Android these should no longer occur (as of 2016 v3). Common error code for all API Methods.

InvalidAppCredential

Indicates that an invalid APNS device token was used in the verifyClient request.

Note:This error is iOS-specific.

InvalidClientId

Indicates that the clientID used to invoke a web flow is invalid.

Note:This error is iOS-specific.

InvalidContinueUri

Indicates that the domain specified in the continue URI is not valid.

Note:This error is iOS-specific.

InvalidCredential

Indicates the IDP token or requestUri is invalid.

Caused by "Sign in with credential" methods.

InvalidCustomToken

Indicates a validation error with the custom token.

This error originates from "bring your own auth" methods.

InvalidEmail

Indicates an invalid email address.

Caused by "Sign in with password" methods.

InvalidMessagePayload

Indicates that there are invalid parameters in the payload during a "send password reset email" attempt.

InvalidPhoneNumber

Indicates that an invalid phone number was provided.

This is caused when the user is entering a phone number for verification.

InvalidRecipientEmail

Indicates that the recipient email is invalid.

InvalidSender

Indicates that the sender email is invalid during a "send password reset email" attempt.

InvalidUserToken

Indicates user's saved auth credential is invalid, the user needs to sign in again.

Caused by requests with an STS id token.

InvalidVerificationCode

Indicates that an invalid verification code was used in the verifyPhoneNumber request.

InvalidVerificationId

Indicates that an invalid verification ID was used in the verifyPhoneNumber request.

KeychainError

Indicates an error occurred while attempting to access the keychain.

Common error code for all API Methods.

Note:This error is iOS-specific.

MissingAppCredential

Indicates that the APNS device token is missing in the verifyClient request.

Note:This error is iOS-specific.

MissingAppToken

Indicates that the APNs device token could not be obtained.

The app may not have set up remote notification correctly, or may have failed to forward the APNs device token to FIRAuth if app delegate swizzling is disabled.

Note:This error is iOS-specific.

MissingContinueUri

Indicates that a continue URI was not provided in a request to the backend which requires one.

Note:This error is iOS-specific.

MissingEmail

Indicates that an email address was expected but one was not provided.

MissingIosBundleId

Indicates that the iOS bundle ID is missing when an iOS App Store ID is provided.

Note:This error is iOS-specific.

MissingPassword

Represents the error code for when an application attempts to create an email/password account with an empty/null password field.

Note:This error is only reported on Android.

MissingPhoneNumber

Indicates that a phone number was not provided during phone number verification.

Note:This error is iOS-specific.

MissingVerificationCode

Indicates that the phone auth credential was created with an empty verification code.

MissingVerificationId

Indicates that the phone auth credential was created with an empty verification ID.

NetworkRequestFailed

Indicates a network error occurred (such as a timeout, interrupted connection, or unreachable host).

These types of errors are often recoverable with a retry. Common error code for all API Methods.

NoSignedInUser

Internal api usage error code when there is no signed-in user and getAccessToken is called.

Note:This error is only reported on Android.

NoSuchProvider

Indicates an attempt to unlink a provider that is not linked.

Caused by "Link credential" methods.

None

Success.

NotificationNotForwarded

Indicates that the app fails to forward remote notification to FIRAuth.

Note:This error is iOS-specific.

OperationNotAllowed

Indicates the administrator disabled sign in with the specified identity provider.

Caused by "Set account info" methods.

ProviderAlreadyLinked

Indicates an attempt to link a provider to which the account is already linked.

Caused by "Link credential" methods.

QuotaExceeded

Indicates that the quota of SMS messages for a given project has been exceeded.

RequiresRecentLogin

Indicates the user has attemped to change email or password more than 5 minutes after signing in, and will need to refresh the credentials.

Caused by "Set account info" methods.

RetryPhoneAuth

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 message to find out the specific cause. Note:This error is only reported on Android.

SessionExpired

Indicates that the SMS code has expired.

TooManyRequests

Indicates that too many requests were made to a server method.

Common error code for all API methods.

UnauthorizedDomain

Indicates that the domain specified in the continue URL is not white- listed in the Firebase console.

Note:This error is iOS-specific.

Unimplemented

Function will be implemented in a later revision of the API.

UserDisabled

Indicates the user’s account is disabled on the server.

Caused by "Sign in with credential" methods.

UserMismatch

Indicates that an attempt was made to reauthenticate with a user which is not the current user.

UserNotFound

Indicates the user account was not found.

Send password request email error code. Common error code for all API methods.

UserTokenExpired

Indicates the saved token has expired.

For example, the user may have changed account password on another device. The user needs to sign in again on the device that made this request. Caused by requests with an STS id token.

WeakPassword

Indicates an attempt to set a password that is considered too weak.

WebContextAlreadyPresented

Indicates that an attempt was made to present a new web context while one was already being presented.

Note:This error is iOS-specific.

WebContextCancelled

Indicates that the URL presentation was cancelled prematurely by the user.

Note:This error is iOS-specific.

WrongPassword

Indicates the user attempted sign in with a wrong password.

Caused by "Sign in with password" methods.

Send feedback about...

Need help? Visit our support page.