providers/firebase library
This library contains the Firebase authentication provider for the Serverpod Idp module.
Classes
- AuthSuccess
- Response model representing a successful authentication result with all relevant authentication information.
- FirebaseAccount
- A fully configured Firebase account to be used for logins.
- FirebaseIdp
- Main class for the Firebase identity provider.
- FirebaseIdpAdmin
- Admin operations for the Firebase identity provider.
- FirebaseIdpBaseEndpoint
- Base endpoint for Firebase Account-based authentication.
- FirebaseIdpConfig
- Configuration for the Firebase identity provider.
- FirebaseIdpConfigFromPasswords
-
Creates a new FirebaseIdpConfig from keys on the
passwords.yamlfile. - FirebaseIdpUtils
- Utility functions for the Firebase identity provider.
- FirebaseServiceAccountCredentials
- Contains information about the Firebase service account credentials.
Extensions
- FirebaseIdpGetter on AuthServices
- Extension to get the FirebaseIdp instance from the AuthServices.
Typedefs
- FirebaseAccountDetails = ({String? email, String? fullName, Uri? image, String? phone, String userIdentifier, bool? verifiedEmail})
- Details of the Firebase Account.
- FirebaseAccountDetailsValidation = void Function(FirebaseAccountDetails accountDetails)
- Function to be called to check whether Firebase account details match the requirements during registration.
-
FirebaseAuthSuccess
= ({UuidValue authUserId, FirebaseAccountDetails details, UuidValue firebaseAccountId, bool newAccount, Set<
Scope> scopes}) - Result of a successful authentication using Firebase as identity provider.
Exceptions / Errors
- FirebaseIdTokenValidationServerException
- Exception thrown when the Firebase ID token validation fails.
- FirebaseIdTokenVerificationException
- Exception to be thrown if the Firebase ID token verification fails.
- FirebaseUserInfoMissingDataException
- Exception thrown when the user info from Firebase is missing required data.