devsite/tools/jazzy/templates

FirebaseAuth Framework Reference

AuthErrorCode

@objc(FIRAuthErrorCode)
public enum AuthErrorCode : Int, Error

Error codes used by Firebase Auth.

  • Indicates a validation error with the custom token.

    Declaration

    Swift

    case invalidCustomToken = 17000
  • Indicates the service account and the API key belong to different projects.

    Declaration

    Swift

    case customTokenMismatch = 17002
  • Indicates the IDP token or requestUri is invalid.

    Declaration

    Swift

    case invalidCredential = 17004
  • Indicates the user’s account is disabled on the server.

    Declaration

    Swift

    case userDisabled = 17005
  • Indicates the administrator disabled sign in with the specified identity provider.

    Declaration

    Swift

    case operationNotAllowed = 17006
  • Indicates the email used to attempt a sign up is already in use.

    Declaration

    Swift

    case emailAlreadyInUse = 17007
  • Indicates the email is invalid.

    Declaration

    Swift

    case invalidEmail = 17008
  • Indicates the user attempted sign in with a wrong password.

    Declaration

    Swift

    case wrongPassword = 17009
  • Indicates that too many requests were made to a server method.

    Declaration

    Swift

    case tooManyRequests = 17010
  • Indicates the user account was not found.

    Declaration

    Swift

    case userNotFound = 17011
  • Indicates account linking is required.

    Declaration

    Swift

    case accountExistsWithDifferentCredential = 17012
  • Indicates the user has attempted to change email or password more than 5 minutes after signing in.

    Declaration

    Swift

    case requiresRecentLogin = 17014
  • Indicates an attempt to link a provider to which the account is already linked.

    Declaration

    Swift

    case providerAlreadyLinked = 17015
  • Indicates an attempt to unlink a provider that is not linked.

    Declaration

    Swift

    case noSuchProvider = 17016
  • Indicates user’s saved auth credential is invalid the user needs to sign in again.

    Declaration

    Swift

    case invalidUserToken = 17017
  • Indicates a network error occurred (such as a timeout interrupted connection or unreachable host). These types of errors are often recoverable with a retry. The NSUnderlyingError field in the NSError.userInfo dictionary will contain the error encountered.

    Declaration

    Swift

    case networkError = 17020
  • 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.

    Declaration

    Swift

    case userTokenExpired = 17021
  • Indicates an invalid API key was supplied in the request.

    Declaration

    Swift

    case invalidAPIKey = 17023
  • Indicates that an attempt was made to reauthenticate with a user which is not the current user.

    Declaration

    Swift

    case userMismatch = 17024
  • Indicates an attempt to link with a credential that has already been linked with a different Firebase account.

    Declaration

    Swift

    case credentialAlreadyInUse = 17025
  • Indicates an attempt to set a password that is considered too weak.

    Declaration

    Swift

    case weakPassword = 17026
  • Indicates the App is not authorized to use Firebase Authentication with the provided API Key.

    Declaration

    Swift

    case appNotAuthorized = 17028
  • Indicates the OOB code is expired.

    Declaration

    Swift

    case expiredActionCode = 17029
  • Indicates the OOB code is invalid.

    Declaration

    Swift

    case invalidActionCode = 17030
  • Indicates that there are invalid parameters in the payload during a “send password reset email” attempt.

    Declaration

    Swift

    case invalidMessagePayload = 17031
  • Indicates that the sender email is invalid during a “send password reset email” attempt.

    Declaration

    Swift

    case invalidSender = 17032
  • Indicates that the recipient email is invalid.

    Declaration

    Swift

    case invalidRecipientEmail = 17033
  • Indicates that an email address was expected but one was not provided.

    Declaration

    Swift

    case missingEmail = 17034
  • Indicates that the iOS bundle ID is missing when a iOS App Store ID is provided.

    Declaration

    Swift

    case missingIosBundleID = 17036
  • Indicates that the android package name is missing when the androidInstallApp flag is set to true.

    Declaration

    Swift

    case missingAndroidPackageName = 17037
  • Indicates that the domain specified in the continue URL is not allowlisted in the Firebase console.

    Declaration

    Swift

    case unauthorizedDomain = 17038
  • Indicates that the domain specified in the continue URI is not valid.

    Declaration

    Swift

    case invalidContinueURI = 17039
  • Indicates that a continue URI was not provided in a request to the backend which requires one.

    Declaration

    Swift

    case missingContinueURI = 17040
  • Indicates that a phone number was not provided in a call to verifyPhoneNumber:completion:.

    Declaration

    Swift

    case missingPhoneNumber = 17041
  • Indicates that an invalid phone number was provided in a call to verifyPhoneNumber:completion:.

    Declaration

    Swift

    case invalidPhoneNumber = 17042
  • Indicates that the phone auth credential was created with an empty verification code.

    Declaration

    Swift

    case missingVerificationCode = 17043
  • Indicates that an invalid verification code was used in the verifyPhoneNumber request.

    Declaration

    Swift

    case invalidVerificationCode = 17044
  • Indicates that the phone auth credential was created with an empty verification ID.

    Declaration

    Swift

    case missingVerificationID = 17045
  • Indicates that an invalid verification ID was used in the verifyPhoneNumber request.

    Declaration

    Swift

    case invalidVerificationID = 17046
  • Indicates that the APNS device token is missing in the verifyClient request.

    Declaration

    Swift

    case missingAppCredential = 17047
  • Indicates that an invalid APNS device token was used in the verifyClient request.

    Declaration

    Swift

    case invalidAppCredential = 17048
  • Indicates that the SMS code has expired.

    Declaration

    Swift

    case sessionExpired = 17051
  • Indicates that the quota of SMS messages for a given project has been exceeded.

    Declaration

    Swift

    case quotaExceeded = 17052
  • Indicates that the APNs device token could not be obtained. The app may not have set up remote notification correctly or may fail to forward the APNs device token to Auth if app delegate swizzling is disabled.

    Declaration

    Swift

    case missingAppToken = 17053
  • Indicates that the app fails to forward remote notification to FIRAuth.

    Declaration

    Swift

    case notificationNotForwarded = 17054
  • Indicates that the app could not be verified by Firebase during phone number authentication.

    Declaration

    Swift

    case appNotVerified = 17055
  • Indicates that the reCAPTCHA token is not valid.

    Declaration

    Swift

    case captchaCheckFailed = 17056
  • Indicates that an attempt was made to present a new web context while one was already being presented.

    Declaration

    Swift

    case webContextAlreadyPresented = 17057
  • Indicates that the URL presentation was cancelled prematurely by the user.

    Declaration

    Swift

    case webContextCancelled = 17058
  • Indicates a general failure during the app verification flow.

    Declaration

    Swift

    case appVerificationUserInteractionFailure = 17059
  • Indicates that the clientID used to invoke a web flow is invalid.

    Declaration

    Swift

    case invalidClientID = 17060
  • Indicates that a network request within a SFSafariViewController or WKWebView failed.

    Declaration

    Swift

    case webNetworkRequestFailed = 17061
  • Indicates that an internal error occurred within a SFSafariViewController or WKWebView.

    Declaration

    Swift

    case webInternalError = 17062
  • Indicates a general failure during a web sign-in flow.

    Declaration

    Swift

    case webSignInUserInteractionFailure = 17063
  • Indicates that the local player was not authenticated prior to attempting Game Center signin.

    Declaration

    Swift

    case localPlayerNotAuthenticated = 17066
  • Indicates that a non-null user was expected as an argument to the operation but a null user was provided.

    Declaration

    Swift

    case nullUser = 17067
  • Indicates that a Firebase Dynamic Link is not activated.

    Declaration

    Swift

    case dynamicLinkNotActivated = 17068
  • Represents the error code for when the given provider id for a web operation is invalid.

    Declaration

    Swift

    case invalidProviderID = 17071
  • Represents the error code for when an attempt is made to update the current user with a tenantId that differs from the current FirebaseAuth instance’s tenantId.

    Declaration

    Swift

    case tenantIDMismatch = 17072
  • Represents the error code for when a request is made to the backend with an associated tenant ID for an operation that does not support multi-tenancy.

    Declaration

    Swift

    case unsupportedTenantOperation = 17073
  • Indicates that the Firebase Dynamic Link domain used is either not configured or is unauthorized for the current project.

    Declaration

    Swift

    case invalidDynamicLinkDomain = 17074
  • Indicates that the credential is rejected because it’s malformed or mismatching.

    Declaration

    Swift

    case rejectedCredential = 17075
  • Indicates that the GameKit framework is not linked prior to attempting Game Center signin.

    Declaration

    Swift

    case gameKitNotLinked = 17076
  • Indicates that the second factor is required for signin.

    Declaration

    Swift

    case secondFactorRequired = 17078
  • Indicates that the multi factor session is missing.

    Declaration

    Swift

    case missingMultiFactorSession = 17081
  • Indicates that the multi factor info is missing.

    Declaration

    Swift

    case missingMultiFactorInfo = 17082
  • Indicates that the multi factor session is invalid.

    Declaration

    Swift

    case invalidMultiFactorSession = 17083
  • Indicates that the multi factor info is not found.

    Declaration

    Swift

    case multiFactorInfoNotFound = 17084
  • Indicates that the operation is admin restricted.

    Declaration

    Swift

    case adminRestrictedOperation = 17085
  • Indicates that the email is required for verification.

    Declaration

    Swift

    case unverifiedEmail = 17086
  • Indicates that the second factor is already enrolled.

    Declaration

    Swift

    case secondFactorAlreadyEnrolled = 17087
  • Indicates that the maximum second factor count is exceeded.

    Declaration

    Swift

    case maximumSecondFactorCountExceeded = 17088
  • Indicates that the first factor is not supported.

    Declaration

    Swift

    case unsupportedFirstFactor = 17089
  • Indicates that the a verified email is required to changed to.

    Declaration

    Swift

    case emailChangeNeedsVerification = 17090
  • Indicates that the request does not contain a client identifier.

    Declaration

    Swift

    case missingClientIdentifier = 17093
  • Indicates that the nonce is missing or invalid.

    Declaration

    Swift

    case missingOrInvalidNonce = 17094
  • Raised when n Cloud Function returns a blocking error. Will include a message returned from the function.

    Declaration

    Swift

    case blockingCloudFunctionError = 17105
  • Indicates that reCAPTCHA Enterprise integration is not enabled for this project.

    Declaration

    Swift

    case recaptchaNotEnabled = 17200
  • Indicates that the reCAPTCHA token is missing from the backend request.

    Declaration

    Swift

    case missingRecaptchaToken = 17201
  • Indicates that the reCAPTCHA token sent with the backend request is invalid.

    Declaration

    Swift

    case invalidRecaptchaToken = 17202
  • Indicates that the requested reCAPTCHA action is invalid.

    Declaration

    Swift

    case invalidRecaptchaAction = 17203
  • Indicates that the client type is missing from the request.

    Declaration

    Swift

    case missingClientType = 17204
  • Indicates that the reCAPTCHA version is missing from the request.

    Declaration

    Swift

    case missingRecaptchaVersion = 17205
  • Indicates that the reCAPTCHA version sent to the backend is invalid.

    Declaration

    Swift

    case invalidRecaptchaVersion = 17206
  • Indicates that the request type sent to the backend is invalid.

    Declaration

    Swift

    case invalidReqType = 17207
  • Indicates that the reCAPTCHA SDK is not linked to the app.

    Declaration

    Swift

    case recaptchaSDKNotLinked = 17208
  • Indicates that the reCAPTCHA SDK site key wasn’t found.

    Declaration

    Swift

    case recaptchaSiteKeyMissing = 17209
  • Indicates that the reCAPTCHA SDK actions class failed to create.

    Declaration

    Swift

    case recaptchaActionCreationFailed = 17210
  • Indicates an error occurred while attempting to access the keychain.

    Declaration

    Swift

    case keychainError = 17995
  • Indicates an internal error occurred.

    Declaration

    Swift

    case internalError = 17999
  • Raised when a JWT fails to parse correctly. May be accompanied by an underlying error describing which step of the JWT parsing process failed.

    Declaration

    Swift

    case malformedJWT = 18000
  • The error code. It’s redundant but implemented for compatibility with the Objective-C implementation.

    Declaration

    Swift

    public var code: `Self` { get }