firebase::auth

Firebase Authentication API.

Summary

Firebase Authentication provides backend services to securely authenticate users. It can authenticate users using passwords and federated identity provider credentials, and it can integrate with a custom auth backend.

Enumerations

AuthError{
  kAuthErrorNone = 0,
  kAuthErrorUnimplemented = -1,
  kAuthErrorFailure = 1,
  kAuthErrorInvalidCustomToken,
  kAuthErrorCustomTokenMismatch,
  kAuthErrorInvalidCredential,
  kAuthErrorUserDisabled,
  kAuthErrorAccountExistsWithDifferentCredentials,
  kAuthErrorOperationNotAllowed,
  kAuthErrorEmailAlreadyInUse,
  kAuthErrorRequiresRecentLogin,
  kAuthErrorCredentialAlreadyInUse,
  kAuthErrorInvalidEmail,
  kAuthErrorWrongPassword,
  kAuthErrorTooManyRequests,
  kAuthErrorUserNotFound,
  kAuthErrorProviderAlreadyLinked,
  kAuthErrorNoSuchProvider,
  kAuthErrorInvalidUserToken,
  kAuthErrorUserTokenExpired,
  kAuthErrorNetworkRequestFailed,
  kAuthErrorInvalidApiKey,
  kAuthErrorAppNotAuthorized,
  kAuthErrorUserMismatch,
  kAuthErrorWeakPassword,
  kAuthErrorNoSignedInUser,
  kAuthErrorApiNotAvailable,
  kAuthErrorExpiredActionCode,
  kAuthErrorInvalidActionCode,
  kAuthErrorInvalidMessagePayload,
  kAuthErrorInvalidPhoneNumber,
  kAuthErrorMissingPhoneNumber,
  kAuthErrorInvalidRecipientEmail,
  kAuthErrorInvalidSender,
  kAuthErrorInvalidVerificationCode,
  kAuthErrorInvalidVerificationId,
  kAuthErrorMissingVerificationCode,
  kAuthErrorMissingVerificationId,
  kAuthErrorMissingEmail,
  kAuthErrorMissingPassword,
  kAuthErrorQuotaExceeded,
  kAuthErrorRetryPhoneAuth,
  kAuthErrorSessionExpired,
  kAuthErrorAppNotVerified,
  kAuthErrorAppVerificationFailed,
  kAuthErrorCaptchaCheckFailed,
  kAuthErrorInvalidAppCredential,
  kAuthErrorMissingAppCredential,
  kAuthErrorInvalidClientId,
  kAuthErrorInvalidContinueUri,
  kAuthErrorMissingContinueUri,
  kAuthErrorKeychainError,
  kAuthErrorMissingAppToken,
  kAuthErrorMissingIosBundleId,
  kAuthErrorNotificationNotForwarded,
  kAuthErrorUnauthorizedDomain,
  kAuthErrorWebContextAlreadyPresented,
  kAuthErrorWebContextCancelled,
  kAuthErrorDynamicLinkNotActivated,
  kAuthErrorCancelled,
  kAuthErrorInvalidProviderId,
  kAuthErrorWebInternalError,
  kAuthErrorWebStorateUnsupported,
  kAuthErrorTenantIdMismatch,
  kAuthErrorUnsupportedTenantOperation,
  kAuthErrorInvalidLinkDomain,
  kAuthErrorRejectedCredential,
  kAuthErrorPhoneNumberNotFound,
  kAuthErrorInvalidTenantId
}
enum
All possible error codes from asynchronous calls.

Classes

firebase::auth::Auth

Firebase authentication object.

firebase::auth::AuthStateListener

Listener called when there is a change in the 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::GameCenterAuthProvider

GameCenter (iOS) 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::IdTokenListener

Listener called when there is a change in the ID token.

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::TwitterAuthProvider

Use a token and secret provided by Twitter to authenticate.

firebase::auth::User

Firebase user account object.

firebase::auth::UserInfoInterface

Interface implemented by each identity provider.

Structs

firebase::auth::AdditionalUserInfo

Additional user data returned from an identity provider.

firebase::auth::SignInResult

Result of operations that can affect authentication state.

firebase::auth::UserMetadata

Metadata corresponding to a Firebase user.

Enumerations

AuthError

 AuthError

All possible error codes from asynchronous calls.

For error details, call Future::ErrorMessage().

Properties
kAuthErrorAccountExistsWithDifferentCredentials

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.

kAuthErrorApiNotAvailable

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.

kAuthErrorAppNotAuthorized

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.

kAuthErrorAppNotVerified

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

Note:This error is iOS-specific.

kAuthErrorAppVerificationFailed

Indicates a general failure during the app verification flow.

Note:This error is iOS-specific.

kAuthErrorCancelled