Navigate

FirebaseAuth Swift Conformance

This page tracks an integration contract: unchanged Firebase code run through a Pyric runtime seam, so there is no separate Firebase public API to measure. The rows below are its signed behavior inventory.

Compatibility reference for Pyric’s pure-Swift client conforming to FirebaseAuth via the Pyric WebSocket bridge.

Auth — instance & lifecycle

Auth.auth()Returns the default Auth instance configured with the default FirebaseApp.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#1.
Auth.auth(app:)Returns an Auth instance associated with the specified FirebaseApp.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#2.
Auth.reset()Resets cached Auth instances across all FirebaseApp instances.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#3.
Auth.appReturns the FirebaseApp instance associated with this Auth instance.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#4.
Auth.useEmulator(withHost:port:)Configures the Auth client to connect to local Pyric emulator WebSocket endpoint.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#5.

Auth — authentication operations

Auth.signIn(withEmail:password:)Authenticates a user with email and password asynchronously, returning AuthDataResult.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#6.
Auth.signIn(withEmail:password:completion:)Authenticates a user with email and password using a completion closure.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#7.
Auth.createUser(withEmail:password:)Creates a new user account with email and password asynchronously, returning AuthDataResult.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#8.
Auth.createUser(withEmail:password:completion:)Creates a new user account with email and password using a completion closure.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#9.
Auth.signInAnonymously()Signs in as an anonymous user asynchronously, returning AuthDataResult.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#10.
Auth.signInAnonymously(completion:)Signs in as an anonymous user using a completion closure.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#11.
Auth.signOut()Signs out the current user, clears currentUser, and notifies all state listeners.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#12.
Auth.restoreSession(uid:)Restores an authenticated session for the given UID via the Pyric bridge.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#13.

Auth — state listeners & reactive streams

Auth.currentUserReturns the currently authenticated User, or nil if no user is signed in.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#14.
Auth.addStateDidChangeListener(_:)Attaches an auth state change listener callback that fires immediately and on state transitions.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#15.
Auth.removeStateDidChangeListener(_:)Detaches an auth state change listener using its registration handle.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#16.
Auth.addIDTokenDidChangeListener(_:)Attaches an ID token listener callback that fires immediately and on token refreshes or user transitions.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#17.
Auth.removeIDTokenDidChangeListener(_:)Detaches an ID token change listener using its registration handle.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#18.
Auth.authStateDidChangeStreamProvides an AsyncStream of User? updates emitted on authentication state changes.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#19.
Auth.idTokenDidChangeStreamProvides an AsyncStream of User? updates emitted on ID token changes or refreshes.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#20.
Auth.authStateChangesExposes an AsyncSequence for modern async/await iteration over auth state transitions.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#21.
Auth.idTokenChangesExposes an AsyncSequence for modern async/await iteration over ID token transitions.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#22.
Auth.authStatePublisherExposes a Combine AnyPublisher emitting User? on auth state transitions.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#23.
Auth.idTokenPublisherExposes a Combine AnyPublisher emitting User? on ID token transitions.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#24.

User — identity properties

User.uidReturns the unique string identifier for the user account.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#25.
User.emailReturns the user's primary email address if available.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#26.
User.displayNameReturns the user's display name if set.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#27.
User.photoURLReturns the user's profile photo URL if set.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#28.
User.phoneNumberReturns the user's phone number if available.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#29.
User.isAnonymousIndicates whether the user account is anonymous.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#30.
User.isEmailVerifiedIndicates whether the user's primary email address has been verified.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#31.
User.providerIDReturns the provider identifier for the user identity.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#32.
User.providerDataReturns an array of UserInfo objects representing linked authentication providers.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#33.
User.tenantReturns the tenant identifier associated with the user in multi-tenant configurations.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#34.
User.claimsReturns the dictionary of custom and standard claims associated with the user's ID token.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#35.

User — token retrieval & mutations

User.getIDToken(forcingRefresh:)Retrieves the Firebase Auth ID token string asynchronously, optionally forcing a refresh.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#36.
User.getIDToken(forcingRefresh:completion:)Retrieves the Firebase Auth ID token string using a completion closure.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#37.
User.getIDTokenResult(forcingRefresh:)Retrieves detailed AuthTokenResult with expiration and claims asynchronously.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#38.
User.getIDTokenResult(forcingRefresh:completion:)Retrieves detailed AuthTokenResult using a completion closure.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#39.
User.updateProfile(displayName:photoURL:)Updates the user's display name and photo URL asynchronously.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#40.
User.reload()Refreshes user account data and custom claims from the Pyric backend asynchronously.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#41.

Supporting types & metadata

AuthDataResult.userReturns the User instance associated with the authentication result.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#42.
AuthDataResult.additionalUserInfoReturns AdditionalUserInfo containing provider ID and isNewUser flag.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#43.
AuthTokenResult.tokenReturns the JWT token string.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#44.
AuthTokenResult.claimsReturns the decoded token claims dictionary.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#45.
AuthTokenResult.expirationTimeReturns the expiration timestamp of the ID token.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#46.
UserInfoImplConforms to UserInfo protocol representing user attributes from an auth provider.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#47.

Multi-tenancy, Impersonation & Firestore Coupling

Auth.switchLens(_:)Sets or clears an active impersonation AuthLens (.admin, .asUser, .anon).
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#48.
Auth.currentAuthLens()Computes the effective AuthLens based on active impersonation or currentUser state.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#49.
Auth.authLensStreamEmits AuthLens updates whenever user transitions occur or impersonation lens changes.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#50.
FirebaseAuthBootstrap.initialize()Registers Auth as the Firestore AuthCredentialProvider factory.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#51.
SnapshotSubscriptionCoordinator re-subscriptionAuth state and token transitions trigger Firestore snapshot listener re-subscription.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#52.

Error handling

AuthErrorCodeEnumerates standard Firebase Auth error codes (e.g. invalidEmail, wrongPassword, userNotFound).
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#53.
AuthErrorConforms to LocalizedError and maps wire error codes to structured AuthErrorCode.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#54.

OAuth providers & credential authentication

GoogleAuthProvider.credential(withIDToken:accessToken:)Constructs an AuthCredential for Google Sign-In ("google.com") encapsulating ID token and access token.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#55.
OAuthProvider.credential(withProviderID:idToken:rawNonce:accessToken:)Constructs an OAuthCredential for arbitrary OAuth providers (e.g. "apple.com", "github.com") with ID token, access token, and optional raw nonce.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#56.
Auth.signIn(with:)Authenticates a user with an AuthCredential asynchronously via bridge auth.signInWithCredential RPC, returning AuthDataResult and updating currentUser.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#57.
Auth.signIn(with:completion:)Authenticates a user with an AuthCredential using a completion closure.
FirebaseAuth Swift specification. Swift test: packages/swift-client/Tests/PyricAuthTests/AuthConformanceTests.swift assertion set auth-swift#58.