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,   DynamicLinkNotActivated,   Cancelled,   InvalidProviderId,   WebInternalError,   WebStorateUnsupported,   TenantIdMismatch,   UnsupportedTenantOperation,   InvalidLinkDomain,   RejectedCredential,   PhoneNumberNotFound,   InvalidTenantId,   MissingClientIdentifier,   MissingMultiFactorSession,   MissingMultiFactorInfo,   InvalidMultiFactorSession,   MultiFactorInfoNotFound,   AdminRestrictedOperation,   UnverifiedEmail,   SecondFactorAlreadyEnrolled,   MaximumSecondFactorCountExceeded,   UnsupportedFirstFactor,   EmailChangeNeedsVerification }

enum All possible error codes from asynchronous calls.

Classes
Firebase.Auth.AdditionalUserInfo	Additional user data returned from an identity provider.
Firebase.Auth.AuthResult	The result of operations that can affect authentication state.
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.FederatedAuthProvider	Used to authenticate with Federated Auth Providers.
Firebase.Auth.FederatedOAuthProvider	Authenticates with Federated OAuth Providers via the firebase::auth::Auth and firebase::auth::User classes.
Firebase.Auth.FederatedOAuthProviderData	Contains information to identify an OAuth povider.
Firebase.Auth.FederatedProviderData	Contains information required to authenticate with a third party provider.
Firebase.Auth.FirebaseAccountLinkException	Exception thrown for failed Account Link Attempts.
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.GameCenterAuthProvider	GameCenter (Apple) auth provider.
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.MicrosoftAuthProvider	Use an access token provided by Microsoft to authenticate.
Firebase.Auth.OAuthProvider	OAuth2.0+UserInfo auth provider (OIDC compliant and non-compliant).
Firebase.Auth.PhoneAuthCredential	Wraps phone number and verification information for authentication purposes.
Firebase.Auth.PhoneAuthOptions	Options object for configuring phone validation flows in PhoneAuthProvider.
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.TwitterAuthProvider	Use a token and secret provided by Twitter to authenticate.
Firebase.Auth.UserInfoInterface	Interface implemented by each identity provider.
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.
AdminRestrictedOperation	Indicates that a request was made that is restricted to administrators only.
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.
Cancelled	Indicates that the operation was cancelled.
CaptchaCheckFailed	Indicates that the reCAPTCHA token is not valid. Note: This error is iOS and tvOS-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.
DynamicLinkNotActivated	Indicates that Dynamic Links in the Firebase Console is not activated.
EmailAlreadyInUse	Indicates the email used to attempt a sign up is already in use. Caused by "Set account info" methods.
EmailChangeNeedsVerification	Indicates that a second factor users attempted to change their email with updateEmail instead of verifyBeforeUpdateEmail.
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 and tvOS-specific.
InvalidClientId	Indicates that the clientID used to invoke a web flow is invalid. Note: This error is iOS and tvOS-specific.
InvalidContinueUri	Indicates that the domain specified in the continue URI is not valid. Note: This error is iOS and tvOS-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.
InvalidLinkDomain	Indicates that an FDL domain used for an out of band code flow is either not configured or is unauthorized for the current project.
InvalidMessagePayload	Indicates that there are invalid parameters in the payload during a "send password reset email" attempt.
InvalidMultiFactorSession	Indicates that a second factor challenge request was made containing an invalid proof of first factor sign-in.
InvalidPhoneNumber	Indicates that an invalid phone number was provided. This is caused when the user is entering a phone number for verification.
InvalidProviderId	Indicates that the provider id given for the web operation is invalid.
InvalidRecipientEmail	Indicates that the recipient email is invalid.
InvalidSender	Indicates that the sender email is invalid during a "send password reset email" attempt.
InvalidTenantId	Indicates that a request was made to the backend with an invalid tenant ID.
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 and tvOS-specific.
MaximumSecondFactorCountExceeded	Indicates that the user has reached the maximum number of allowed second factors and is attempting to enroll another one.
MissingAppCredential	Indicates that the APNS device token is missing in the verifyClient request. Note: This error is iOS and tvOS-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 and tvOS-specific.
MissingClientIdentifier	Indicates that a request was made to the backend without a valid client identifier.
MissingContinueUri	Indicates that a continue URI was not provided in a request to the backend which requires one.
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 and tvOS-specific.
MissingMultiFactorInfo	Indicates that a second factor challenge request was made where a second factor identifier was not provided.
MissingMultiFactorSession	Indicates that a second factor challenge request was made without proof of a successful first factor sign-in.
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.
MultiFactorInfoNotFound	Indicates that the user does not have a second factor matching the provided identifier.
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 and tvOS-specific.
OperationNotAllowed	Indicates the administrator disabled sign in with the specified identity provider. Caused by "Set account info" methods.
PhoneNumberNotFound	Indicates that the phone number provided in the MFA sign in flow to be verified does not correspond to a phone second factor for the user.
ProviderAlreadyLinked	Indicates an attempt to link a provider to which the account is already linked. Caused by "Link credential" methods.
QuotaExceeded	Indicates that the project's quota for this operation (SMS messages, sign-ins, account creation) has been exceeded. Try again later.
RejectedCredential	Indicates that credential related request data is invalid. This can occur when there is a project number mismatch (sessionInfo, spatula header, temporary proof), an incorrect temporary proof phone number, or during game center sign in when the user is already signed into a different game center account.
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.
SecondFactorAlreadyEnrolled	Indicates that the user is trying to enroll a second factor that already exists on their account.
SessionExpired	Indicates that the SMS code has expired.
TenantIdMismatch	Indicates that the provided tenant ID does not match the Auth instance's tenant ID.
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 and tvOS-specific.
Unimplemented	Function will be implemented in a later revision of the API.
UnsupportedFirstFactor	Indicates that a user either attempted to enroll in 2FA with an unsupported first factor or is enrolled and attempts a first factor sign in that is not supported for 2FA users.
UnsupportedTenantOperation	Indicates that a request was made to the backend with an associated tenant ID for an operation that does not support multi-tenancy.
UnverifiedEmail	Indicates that the user's email must be verified to perform that request.
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.
WebContextCancelled	Indicates that the URL presentation was cancelled prematurely by the user.
WebInternalError	Indicates that an internal error occurred during a web operation.
WebStorateUnsupported	Indicates that 3rd party cookies or data are disabled, or that there was a problem with the browser.
WrongPassword	Indicates the user attempted sign in with a wrong password. Caused by "Sign in with password" methods.