Admin API
Firebase Admin SDK wrapper with multi-project support and automatic initialization.
What It Does
The Admin API provides a singleton wrapper around the Firebase Admin SDK for Node.js applications. It automatically initializes Firebase services using environment variables and provides convenient access to all major Firebase Admin features including Firestore, Authentication, Cloud Storage, and Cloud Messaging.
Key Capabilities
| Capability | Description |
|---|---|
| Automatic Initialization | Initializes Firebase Admin SDK on import using environment credentials |
| Singleton Pattern | Ensures only one Firebase instance exists across the application |
| Multi-Project Support | Manage multiple Firebase projects within a single process |
| Service Access | Direct access to Auth, Firestore, Storage, Messaging, Functions, and Realtime DB |
| Credential Management | Models for loading and parsing Firebase/GCP service account credentials |
| Type Safety | Full TypeScript support with Firebase type definitions |
| Storage Bucket Management | Named bucket access with getBucket() utility |
| Multi-Database Support | Access named Firestore databases with getDatabase() |
Exports
Singleton Instances
app- The default Firebase Appfirestore- Firestore databasestorage- Cloud Storage bucketauth- Firebase Authenticationmessaging- Cloud Messagingfunctions- Cloud Functionsapps- Array of all app instancesappNames- Friendly names of registered apps
Utility Functions
getBucket(name?)- Get storage bucket by namegetDatabase(name, app?)- Get named Firestore database
Classes
FirebaseAdminUtil- Firebase instance wrapperFirebaseCredentialModel- Firebase credential modelGCPCredentialModel- GCP credential model
Re-exports
FirebaseError- Firebase error typesadmin- Entire firebase-admin module
Common Use Cases
- Multi-tenant SaaS: Manage separate Firebase projects for each tenant
- Microservices: Shared Firebase initialization across services
- Background jobs: Access Firebase services in Cloud Functions or Cloud Run jobs
- Data migrations: Read/write data across multiple Firebase projects
- Admin dashboards: Build admin tools that manage user accounts and data
Roadmap
Multi-Cloud Support
This API currently supports Google Cloud Platform. Future versions will add support for additional cloud providers and container-based deployment options, enabling greater flexibility in infrastructure choices.
What Customers Don’t Have to Build
- Firebase Admin SDK initialization logic
- Singleton pattern implementation
- Environment variable parsing
- Multi-project management infrastructure
- Service accessor methods
- Bucket selection utilities
- Credential loading and validation
- Database routing logic
- Service instance lifecycle management
Last updated on