Firebase Admin Node.js SDK Release Notes

To review release notes for theFirebase console and for other Firebaseplatforms and related SDKs, refer to theFirebase Release Notes.

Version 13.6.0 - 05 November, 2025

Firebase Data Connect

  • UpdatedFirebase Data Connect APIs to use thev1 serviceendpoint instead of thev1alpha endpoint.

  • Added the newexecuteQuery() andexecuteMutation() APIsallowing for the execution ofFirebase Data Connect operations defined inGraphQL files. Additionally, you can generate atype-safe generated SDK forthese GraphQL operations.

Version 13.5.0 - 28 August, 2025

  • Made theinitializeApp() function idempotent to simplifyinitialization and prevent errors in environments with reused executioncontexts. The function now returns an existingFirebaseApp instanceif called multiple times with an identical configuration. An error will bethrown if an attempt is made to re-initialize an app with the same name buta different configuration.

Cloud Messaging

Version 13.4.0 - 12 May, 2025

Firebase Data Connect

  • Added a specialized interface for bulk data operations,which exposes dedicated methods formutation operations:insert,insertMany,upsert, andupsertMany.

Version 13.3.0 - 22 April, 2025

Cloud Messaging

  • Added support forproxy field in FCMAndroidNotification.
  • Fixed an issue which caused session errors to not be thrown whensending messages using HTTP/2.
  • Unwrapped aggregated HTTP/2 session errors to surface the sub errorswhich caused them.

Version 13.2.0 - 05 March, 2025

Firebase Remote Config

  • Fixed equality comparison for semantic version when the number ofsegments is equal to the max allowed segments.
  • Added support for exporting a serialized config response from theRemote Config server side SDK.

Firebase Data Connect

  • Fixed a bug that was causing credential lookup errors whenconnecting to theFirebase Data Connect emulator.
  • Added support forFirebase Data Connect impersonation whichallows for the execution of admin operations based on limited credentials onbehalf of a specific user.

Cloud Functions

  • Fixed a bug that was causing credential lookup errors whenenqueueing tasks in emulator.

Version 13.1.0 - 05 February, 2025

Authentication

  • AddedUpdateProjectConfigRequest.mobileLinksConfig andActionCodeSettings.linkDomain, allowing you to switch betweenFirebase Dynamic Link and Firebase Hosting domains for out-of-bandemail actions. You can also customize the Firebase Hosting domainused in these flows. As part of this change,ActionCodeSettings.dynamicLinkDomain has been deprecated.

Version 13.0.2 - 19 December, 2024

Authentication

  • Fixed a credentials issue in thecreateCustomToken() APIwhen the SDK is initialized with Google Application Default Credentials.

Version 13.0.1 - 20 November, 2024

  • Fixed an issue that occurred when initializing the SDK with theServiceAccount type.

Version 13.0.0 - 12 November, 2024

  • Migrated credentials handling to usegoogle-auth-library.The SDK now supports new authentication methods includingWorkload Identity Federation and service account impersonation.
  • Dropped support for Node.js 14 and 16. You should use Node.js 18or higher when deploying the Admin SDK.
  • Upgraded TypeScript to v5.5.4.
  • Upgraded the@firebase/database-compat package to v2.

Cloud Messaging

  • Added thedirectBootOk field to theAndroidConfig type.
  • Removed deprecatedsendAll(),sendMulticast(),sendToDevice(),sendToDeviceGroup(),sendToTopic(), andsendToCondition() APIs.

Firebase Remote Config

  • UpdatedFirebase Remote Config condition evaluation hashingby removing the dependency on thefarmhash-modern package.This change will impact random assignment when using thepercentage condition.We recommend resolving any uses of the percent condition that may besensitive to re-assignment before upgrading to this SDK version.Going forward, all assignments will continue to be persistentacross future SDK versions.

Version 12.7.0 - 24 October, 2024

  • This version pins@firebase/database-compat tov1.0.8and@firebase/database-types tov1.0.5 to maintain compatibility withNode.js 14 and 16. Node.js 14 and 16 support is deprecated and Node.js 18+will be required in the next major version.

Authentication

  • Added reCAPTCHA SMS toll fraud protection configuration supportfor phone authentication.

Cloud Functions

  • Added support for both partial and full resource names whenenqueueing tasks in emulator.

Version 12.6.0 - 30 September, 2024

Firebase Data Connect

  • Added the newexecuteGraphql() andexecuteGraphqlRead() APIsto perform administrative queries and mutations on aFirebase Data Connectservice.

  • Added support for theDATA_CONNECT_EMULATOR_HOST environmentvariable.

Authentication

  • UseMath.floor() when settingvalidDuration variable inthecreateSessionCookie() API.

Version 12.5.0 - 12 September, 2024

Firebase App Check

Remote Config

  • Added support for custom conditions when configuringRemote Config server applications. This feature lets you send customRemote Config parameter values to specific clients based onthe conditions you define.

Version 12.4.0 - 22 August, 2024

Cloud Functions

  • Added support for theCLOUD_TASKS_EMULATOR_HOST environmentvariable.

Cloud Messaging

Version 12.3.1 - 08 August, 2024

  • Fixed the internal token handling method to return an existingpromise to a token if one exists instead of creating a new token.

Version 12.3.0 - 25 July, 2024

Firebase Remote Config

  • Replaced thelong.js dependency withBigInt.

Cloud Messaging

  • Added HTTP/2 support forsendEach() andsendEachForMulticast().To use the legacy HTTP/1.1 transport, use theenableLegacyTransport() method.TheenableLegacyTransport() will be removed when the HTTP/2 transportimplementation reaches the same stability as the legacy HTTP/1.1 implementation.

Version 12.2.0 - 20 June, 2024

  • Deprecated support for Node.js 16. Instead use Node.js 18 orhigher when deploying the Admin SDK. Node.js 16 support will be dropped in thenext major version.

  • Fixed optional chaining inFirebaseError type that caused issueswhen usingvitest.

  • Addedx-goog-user-project header to outgoing requests. Thanksfoxrafa for thecontribution.

Firebase Remote Config

  • Replaced thefarmhash package with thefarmhash-modern packageto prevent errors when Python is not installed.

Version 12.1.1 - 21 May, 2024s

Version 12.1.0 - 16 April, 2024

Firebase Remote Config

  • Added server-sideRemote Config support.

Version 12.0.0 - 07 December, 2023

  • Breaking change: Upgraded the@google-cloud/firestore package to v7.This is a breaking change. Refer to the Cloud Firestorerelease notes for more details.

  • Breaking change: Upgraded the@google-cloud/storage package to v7.This is a breaking change. Refer to the Cloud Storagerelease notes for more details.

  • Breaking change: Upgraded TypeScript tov5.1.6.

  • Deprecated support for Node.js 14. Instead use Node.js 16 orhigher when deploying the Admin SDK. Node.js 14 support will be dropped in thenext major version.

Cloud Firestore

Realtime Database

  • Upgraded the@firebase/database-compat package to v1.

Firebase ML

  • Dropped AutoML model support.

Version 11.11.1 - 23 November, 2023

Cloud Firestore

  • Upgraded thegoogle-cloud/firestore dependency to v6.8.0 tosupport multiple named databases.

Version 11.11.0 - 28 September, 2023

Authentication

  • Added email privacy support in project and tenant configuration.

Version 11.10.1 - 13 July, 2023

Realtime Database

  • Fixed an issue which caused the incompatibility inRealtime Databasetypes in version11.10.0.

Version 11.10.0 - 12 July, 2023

Caution: This version introduced a regression inRealtime Database that causedthe incompatibility inRealtime Database types. Upgrade to11.10.1 or later.

Realtime Database

Cloud Storage

  • Added a newgetDownloadURL() API.

Cloud Functions

  • Added the ability to name tasks by including anid whenenqueueing tasks.
  • Added the ability to delete an enqueued task if it has notyet completed.
  • Headers passed toTaskQueue HTTPS handlers are now available inthe context/event object.

Cloud Firestore

  • Added support for multiple named databases. This feature iscurrently in public preview.

Authentication

  • AddedTotpInfo field to theUserRecord type.

  • Fixed a memory leak in the internalhttp timeout handling codethat affected thelistUsers() API. Thanksadrianjost for thecontribution.

Version 11.9.0 - 30 May, 2023

Authentication

  • Added support for configuring password policy in project and tenantconfigurations.

Cloud Firestore

  • ExportedFilter type from theCloud Firestore API.

Version 11.8.0 - 04 May, 2023

Firebase App Check

  • Added replay protection feature in the App CheckverifyToken()API.

Version 11.7.0 - 18 April, 2023

Authentication

  • Added reCAPTCHA configuration support.

Cloud Messaging

  • AddedsendEach() andsendEachForMulticast() APIs.

  • sendAll() andsendMulticast() APIs are now deprecated.UsesendEach() andsendEachForMulticast() APIs instead.

Version 11.6.0 - 06 April, 2023

Authentication

  • AddedTOTP as a multi-factor option in project and tenantconfiguration.

Cloud Messaging

  • DeprecatedsendToDevice andsendToDeviceGroup methods andtheir response classes. These methods are removed in the next major version.

Version 11.5.0 - 19 January, 2023

  • Added support for initializing the SDK with service accountimpersonation in Application Default Credentials. Thanksblue-hope for thecontribution.

Cloud Firestore

  • Fixed a caching issue in theCloud Firestore API wheninitialized with thepreferRest setting to force the use of REST transport.

Version 11.4.1 - 22 December, 2022

  • Updated thejsonwebtoken package tov9.0.0 to addresssecurity concerns.

Version 11.4.0 - 15 December, 2022

Cloud Firestore

  • TheCloud Firestore API now supports thepreferRest settingto force the use of REST transport until an operation requires gRPC.

Cloud Messaging

  • Increased the timeout in theCloud Messaging batch send API to 15seconds to avoid duplicate notifications.

Firebase ML

  • Deprecated AutoML model support. AutoML model support will beremoved in the next major version.

Version 11.3.0 - 17 November, 2022

Firebase Extensions

  • Added a newExtensions API to access theExtensionsruntime methods.

Version 11.2.1 - 10 November, 2022

Cloud Messaging

  • Increased the timeout forCloud Messaging requests to 15seconds to avoid duplicate notifications.

Cloud Firestore

  • Exposed 'ReadWriteTransactionOptions' from thefirestore module.Thanksnaodya for thecontribution.

Version 11.2.0 - 17 October, 2022

Authentication

  • Added SMS region config support for tenant and projectconfiguration.

Cloud Firestore

  • Upgraded the@google-cloud/firestore dependency to v6.4.0 tosupport theCOUNT queries API.

Version 11.1.0 - 06 October, 2022

Cloud Firestore

  • Upgraded the@google-cloud/firestore dependency to v6.3.0.

Cloud Storage

  • Upgraded the@google-cloud/storage dependency to v6.5.2.

Version 11.0.1 - 28 July, 2022

  • Theadmin.securityRules() API now creates a new Security Rulesrelease if one does not already exist.

Authentication

  • ThetoJSON() method inUserMetadata now includeslastRefreshTime in the returned JSON output.

Version 11.0.0 - 16 June, 2022

  • Breaking change: Dropped support for Node.js 12. Developers should use Node.js 14or higher when deploying the Admin SDK.

  • Breaking change: Upgraded TypeScript tov4.6.4.

  • Breaking change: Upgraded the@google-cloud/firestore package to v5.This contains breaking changes. Refer to the Cloud Firestorerelease notes for more details.

  • Breaking change: Upgraded the@google-cloud/storage package to v6.This contains breaking changes. Refer to the Cloud Storagerelease notes for more details.

Version 10.3.0 - 09 June, 2022

  • Deprecated support for Node.js 12. Instead use Node.js 14 orhigher when deploying the Admin SDK. Node.js 12 support will be dropped in thenext major version.

  • Replaced thedicer package with@fastify/busboy to addresssecurity issues indicer.

Version 10.2.0 - 05 May, 2022

Firebase App Check

  • UpdatedFirebase App Check APIs to use thev1 serviceendpoint instead of thev1beta endpoint.

Authentication

  • Added the email action link generation APIs for creating links forthe request typeVERIFY_AND_CHANGE_EMAIL viaauth.generateVerifyAndChangeEmailLink().

Cloud Functions

  • Added an API to enqueue functions with Cloud Tasks.

Version 10.1.0 - 21 April, 2022

  • Upgraded thenode-forge dependency to v1.3.1.

Cloud Firestore

  • Upgraded the@google-cloud/firestore dependency to v4.15.1.

Cloud Storage

  • Upgraded the@google-cloud/storage dependency to v5.18.3.

Version 10.0.2 - 21 January, 2022

Version 10.0.1 - 15 December, 2021

Authentication

  • ThecreateSessionCookie() API now correctly parses and mapsUSER_DISABLED server errors.
  • Removed request body from thedeleteTenant() API.

Cloud Firestore

  • ExposedBundleBuilder,DocumentChange,OrderByDirection,SetOptions, andWhereFilterOp Firestore SDK types from thefirestoremodule and theadmin.firestore namespace.

Version 10.0.0 - 14 October, 2021

  • TheAdmin SDK now requires Node.js 12 or higher. Node.js 10support has been discontinued.
  • TheAdmin SDK now exposes a series of ES module entry points.Developers are recommended to import Admin SDK APIs from these entry points.The namespaced version of the API will be removed in a future major release.Refer to themigration guide for detailson how to update your existing code to use the new ES module entry points.
  • The new module entry points can be used in native ESM runtimes.You can enable the native ESM support on a server running Node.js 12+ bysetting thetype: "module" parameter in your project'spackage.json file.SeeNode.js documentationfor more details.

Version 9.12.0 - 28 September, 2021

Firebase Remote Config

Realtime Database

  • Refactored theadmin.database() API to use the new@firebase/database-compat package under the hood. This helps avoid severaldependency conflicts and type compilation errors when using the Firebase WebSDK packages alongside the Admin SDK.

Version 9.11.1 - 19 August, 2021

Authentication

  • WhencheckRevoked is set totrue, theverifyIdToken() andverifySessionCookie() APIs now throw an error if the user record is disabled.

Version 9.11.0 - 15 July, 2021

Firebase App Check

  • ThecreateToken() API now supports configuring theTTL of thereturned Firebase App Check token.

Version 9.10.0 - 24 June, 2021

Authentication

  • RedefinedAuthProviderConfig,CreateMultiFactorInfoRequest andUpdateMultiFactorInfoRequest interfaces as TypeScript union types. Thisenables simpler and more idiomatic use of these types in developerapplications.

Firebase Installations

  • Added a newadmin.installations() API to replace the existingadmin.instanceId() API.
  • Theadmin.instanceId() API is now deprecated andthe developers are advised to migrate to theadmin.installations() API fordeleting Firebase instance IDs and installation IDs.

Version 9.9.0 - 26 May, 2021

  • The Admin SDK now requires Node.js 10.13.0 or higher.

Authentication

  • Made multi-factor authenticationuid optional forupdateUseroperations.
  • Added support for configuring the authorization code flow forOIDC providers (previously only supported theidToken flow).
  • AddedOAuthResponseType for specifying theresponseType inOIDC provider flow.
  • AddedINVALID_OAUTH_RESPONSETYPE andMISSING_OAUTH_CLIENT_SECRET error codes.

Version 9.8.0 - 10 May, 2021

Authentication

  • The methodgeneratePasswordResetLink() now throwsanauth/email-not-found error code if no user exists for thespecified email address.

Realtime Database

  • Upgraded the@firebase/database dependency to version 0.10.0. Thismakes thestartAfter andendBefore query filters available for Admin SDKusers.

Firebase App Check

  • Added Firebase abuse reduction support APIs.

Version 9.7.0 - 27 April, 2021

Cloud Storage

  • Added support for theFIREBASE_STORAGE_EMULATOR_HOST environmentvariable.

Realtime Database

  • Fixed a token refresh livelock that affected theCloud Functions for Firebase users.

Version 9.6.0 - 29 March, 2021

  • Improved OAuth 2.0 token caching and management. The SDK now treats anyOAuth 2.0 token 5 minutes away from expiration as already expired, and proactivelyrefreshes it. This helps avoid certain types of authorization-related raceconditions.
  • The periodic token refresher background task has been decoupled fromthe SDK core and moved into the RTDB module. This task no longer startsautomatically unless theadmin.database() API is explicitly invoked.

Realtime Database

  • Rules management APIs now support the Firebase emulator suite.Methods likegetRules() andsetRules() will automatically connect to thelocal emulator when the emulator mode is enabled.

Version 9.5.0 - 10 February, 2021

Authentication

  • Added a newgetUserByProviderUid() method to look up useraccounts by their providers.
  • TheupdateUser() method now supports linking a federated ID witha user account.
  • Allowed enabling of anonymous provider via tenant configuration.
  • TheverifyIdToken() method now fully supports theAuthenticationemulator.

Cloud Messaging

Version 9.4.2 - 09 December, 2020

Cloud Messaging

  • Support arbitrary custom values in theApnsPayload type.

Realtime Database

  • Upgraded dependencies@firebase/database and@firebase/database-types to the latest available versions. This resolves aninconsistency in the published typings of the Database API.

Version 9.4.1 - 13 November, 2020

Firebase Remote Config

  • Fixed a timestamp parsing issue inRemote Config templateVersion metadata that was causingFirebase Remote ConfigAPI operations to fail.

Version 9.4.0 - 12 November, 2020

Cloud Firestore

  • Exposed several new types from theadmin.firestore namespace.Newly exposed types includeGrpcStatus,FirestoreDataConverter,UpdateData, and more.
  • Upgraded the@google-cloud/firestore dependency to v4.5.0.

Authentication

  • Fixed a bug that was causing credential lookup errors when invokingsome APIs against the emulator.

Version 9.3.0 - 22 October, 2020

Authentication

  • Added support for generating unsigned custom tokens for testing.
  • Added support for verifying test ID tokens.

Version 9.2.0 - 15 September, 2020

Firebase ML

  • Added support for creating, updating, getting, listing,publishing, unpublishing, and deleting Firebase-hosted custom ML modelscreated with AutoML.

Version 9.1.1 - 20 August, 2020

Firebase Remote Config

Version 9.1.0 - 13 August, 2020

Authentication

  • Added the ability to enable/disable multi-factor authenticationwith SMS on a Google Cloud Identity Platform tenant. Existing APIs likecreateTenant() andupdateTenant() now support configuring multi-factorauthentication and testing phone number/code pairs on a specified tenant.
  • MadedisplayName optional inAuthProviderConfig typings.

Version 9.0.0 - 14 July, 2020

  • TheAdmin SDK now requires Node.js 10 or higher. Node.js 8support has been discontinued.
  • Upgraded dependency on the@google-cloud/firestore package tov4.
  • Upgraded dependency on the@google-cloud/storage package to v5.

Version 8.13.0 - 29 June, 2020

Authentication

  • Fixed a timestamp parsing issue in theUserMetadata.lastRefreshTime field.
  • ThelastRefreshTime field has been removed fromtheUserMetadataRequest type used in theimportUsers() API. Setting thisfield is currently not supported in theFirebase Authentication backend.
  • AddedGetUsersResult andDeleteUsersResults interfaces to theexposed typings.

Firebase Remote Config

  • Added version management support for theadmin.remoteConfig()API. This API now supportslistVersions(),getTemplateAtVersion(), androllback() operations to help developers programmatically manage theirRemote Config templates.

Version 8.12.1 - 08 May, 2020

Authentication

  • Fixed the typings of theUserMetadata type to avoid a potentiallybreaking change.

Version 8.12.0 - 06 May, 2020

Authentication

  • AddedgetUsers() anddeleteUsers() APIs for retrieving anddeleting user accounts in bulk.
  • Updated the typings of thecustomClaims attribute onUserRecordandUserImportRecord interfaces.

Version 8.11.0 - 22 April, 2020

Authentication

  • Exposedemail,email_verified,phone_number, andpicturefields from theDecodedIdToken type.

Realtime Database

  • Upgraded@firebase/database dependency to v0.6.0, which provides anewadmin.database.ServerValue.increment() function and fixed a databaseURL parsing bug to support domains with more than 3 components.

Firebase ML

  • Added a newadmin.machineLearning() API for creating, updating,getting, listing, publishing, unpublishing, and deleting Firebase-hostedcustom ML models.

Firebase Remote Config

  • Added a newadmin.remoteConfig() API. This API enables Firebasedevelopers to programmatically manage the set of JSON-formatted parameters andconditions known as the Remote Config template.

Version 8.10.0 - 12 March, 2020

Authentication

  • Added multi-factor authentication support with SMS forGoogleCloud Identity Platform.Existing APIs likecreateUser() andupdateUser() nowsupport configuring multi-factor authentication settings on user accounts.Seedocumentationfor more details and code samples.
  • Updated typings of theUserRecord.customClaims attribute to allowindexing by string keys. ThankswSedlacek forthecontribution.
  • Fixed a timestamp rounding error in therevokeRefreshTokens() APIthat caused some race conditions.

Version 8.9.2 - 23 January, 2020

  • Fixed a credential loading issue that prevented some functionsfrom being deployed via theFirebase CLI.

Version 8.9.1 - 15 January, 2020

Authentication

  • Fixed the inability to discover the project ID when running on GCPmanaged environments.

Version 8.9.0 - 19 December, 2019

  • Fixed a bug in theadmin.instanceId().deleteInstanceId() API thatcaused errors even when the operation was completed successfully in the backend.
  • Upgraded the@google-cloud/firestore dependency to v3.0.0. See the Firestorereleasenotes for moredetails.

Cloud Messaging

  • ThesendMulticast() API now correctly copies thefcmOptions whensending a message to multiple recipients.

Realtime Database

  • Upgraded the@firebase/database dependency to v0.5.17.

Version 8.8.0 - 19 November, 2019

Cloud Firestore

Cloud Storage

  • Upgraded@google-cloud/storage dependency version to 4.1.2. Thisversion contains some minor breaking changes. Check thereleasenotes of thedependency for more information. Thanksarjunyelfor thecontribution.

Authentication

  • TheverifyIdToken() method now correctly uses thehttp.Agentconfigured during SDK initialization.

Cloud Messaging

  • Batch messaging APIssendAll() andsendMulticast() now supportsending up to 500 messages in a single call.

Version 8.7.0 - 30 October, 2019

Cloud Messaging

  • Added a series of new parameters to theAndroidNotification classthat allow further customization of notifications that target Android devices.

Version 8.6.1 - 16 October, 2019

Authentication

  • UserRecord no longer exposes password hashes that areredacted due to lack of permissions in the service account credentials.
  • Updated the typings of thesetCustomUserClaims() API to acceptnull.

Version 8.6.0 - 18 September, 2019

  • Added a newadmin.securityRules() API for managing Firebasesecurity rules applied on services likeCloud Firestore andCloud Storage.See the Firebase documentation to learn more about how touse the Admin SDK to manage anddeploy security rules.
  • AddedgetFirestoreRuleset() andgetStorageRuleset() methods forretrieving rulesets that are currently in effect.
  • AddedreleaseFirestoreRuleset() andreleaseStorageRuleset()methods for creating new rulesets and applying them toCloud Firestore andCloud Storage.
  • AddedgetRuleset(),createRuleset() anddeleteRuleset()methods for managing the lifecycle of a ruleset.

Cloud Messaging

  • Added new APIs for specifying an image URL in notifications.

Version 8.5.0 - 05 September, 2019

Authentication

  • Added multi-tenancy support to the authentication service (GoogleCloud Identity Platform project required). Tenant related APIs are exposed viatenantManager() ontheadmin.auth interface.
  • Added tenant management APIsauthForTenant(),getTenant(),listTenants(),deleteTenant(),createTenant() andupdateTenant() to thenewly definedTenantManager.
  • DefinedTenantAwareAuth interface retrieved viaTenantManager#authForTenant() for managing users, configuring SAML/OIDCproviders, generating email links for password reset, email verification, etcfor specific tenants.

Realtime Database

  • Upgraded@firebase/database dependency version to 0.5.1. This helpsavoid some peer dependency warnings that were observed during packageinstallation.

Version 8.4.0 - 21 August, 2019

Cloud Messaging

  • Added support for specifyingAnalytics labels for notifications.Thankschemidy for thecontribution.

Version 8.3.0 - July 24, 2019

Realtime Database

Authentication

  • Implemented additional argument validation in theadmin.auth().importUsers() API.

Cloud Storage

  • Upgraded the@google-cloud/storage dependency to v3.0.0.This new major version drops support for Node.js versions older than v8.Sincefirebase-admin already supports only Node.js v8 and above,this does not have a noticeable impact on users of the Admin SDK.

Version 8.2.0 - June 19, 2019

  • Updated the metadata server URL (used by the application defaultcredentials) to thev1 endpoint. This makes it possible to use the SDKin Google Kubernetes Engine again.

Realtime Database

  • Upgraded the@firebase/database dependency to v0.4.4.

Firebase Cloud Messaging

  • Gracefully handling array-like objects inmessaging.sendAll() andmessaging.sendMulticast() APIs.

Version 8.1.0 - June 11, 2019

  • The SDK now automatically retries HTTP calls failing due to 503errors.

Project Management

Version 8.0.0 - May 23, 2019

  • The Admin SDK no longer supports Node 6. Developers must useNode 8.13.0 or higher when deploying the Admin SDK.

Cloud Firestore

  • Upgraded theCloud Firestore client dependency tov2.0.0.This upgrade comes with a pure JS gRPC client implementationthat is much smaller on disk.

Cloud Storage

  • Upgraded theCloud Storage client dependency tov2.5.0.

Version 7.4.0 - May 21, 2019

  • Support for Node 6 is now deprecated. Developers are recommendedto use Node 8 or higher when deploying the Admin SDK. An upcoming releasewill completely drop Node 6 support.

Cloud Firestore

  • Upgraded the Cloud Firestore client dependency tov1.3.0.This upgrade comes with a new API for executing collection groupqueries.

Realtime Database

  • Updated typings of theadmin.database.ThenableReference type toextend from the built-inPromise type.

Version 7.3.0 - April 17, 2019

Authentication

  • Added new APIs for managing SAML and OIDC providerconfigurations. These APIs support CRUD operations on auth providerconfigurations:
    • auth.listProviderConfigs()
    • auth.getProviderConfig()
    • auth.deleteProviderConfig()
    • auth.updateProviderConfig()
    • auth.createProviderConfig()

Version 7.2.0 - March 28, 2019

Cloud Firestore

  • Upgraded the Cloud Firestore client dependency tov1.2.0.This upgrade exposes thev1beta andv1 clients, which provide direct accessto the underlying Firestore and Firestore Admin RPCs. Please note that youmust provide your Firebase credentials directly to these clients.

Version 7.1.1 - March 20, 2019

Firebase Cloud Messaging

  • Fixed a bug in the FCM batch APIs that prevented them fromcorrectly handling some message parameters likeAndroidConfig.ttl.

Version 7.1.0 - March 14, 2019

Firebase Cloud Messaging

Authentication

  • Improved typings of theauth.UpdateRequest interface to clearlyspecify the nullable fields.

Cloud Firestore

  • Upgraded the Cloud Firestore client dependency tov1.1.0.

Version 7.0.0 - January 31, 2019

  • Updated the Google Cloud Firestore client to v1.0.1. This contains breaking changes.Refer to the Cloud Firestorerelease notesfor more details and migration instructions.
  • Updated the Google Cloud Storage client to v2.3.0. This contains breaking changes.Refer to the Cloud Storagerelease notesfor more details and migration instructions.

Authentication

  • TheverifyIdToken() andverifySessionCookie() methods now returnauth/id-token-expired andauth/session-cookie-expired error codes for expired JWTs.
  • Credentials-related errors are now reported with additional helpful details.

Version 6.5.1 - January 23, 2019

  • Setting theGOOGLE_APPLICATION_CREDENTIALS environmentvariable to a refresh token file instead of a service account fileis now supported. Thanksyinzara for thecontribution.
  • Implemented an environment check that is executed atpackage import time. The Admin SDK logs a warning if imported into aclient environment such as a web browser.

Version 6.5.0 - January 9, 2019

Authentication

  • Fixed how the SDK parses the error codes sent by auth backendservers.
  • Correctly marked optional fields in theUserRecord type.

Version 6.4.0 - December 12, 2018

  • AppOptionsnow accepts an optionalhttp.Agent object. Thehttp.Agent specified via this API is used when the SDK makes backendHTTP calls. This can be used when it is required to deploy the Admin SDKbehind a proxy.
  • admin.credential.cert(),admin.credential.applicationDefault(),andadmin.credential.refreshToken() methods now accept anhttp.Agentas an optional argument. If specified, thehttp.Agent is usedwhen calling Google backend servers to fetch OAuth2 access tokens.

Cloud Messaging

Version 6.3.0 - November 28, 2018

  • A newadmin.projectManagement()API for managing apps in a Firebase project.
  • NewlistAndroidApps() andlistIosApps() methods forlisting the existing apps in a project.
  • NewcreateAndroidApp() andcreateIosApp() methodsfor creating new apps in a project.
  • NewAndroidAppandIosAppAPIs for updating individual apps.

Cloud Messaging

Version 6.2.0 - November 19, 2018

Authentication

  • Added the email action link generation APIs for creating linksfor password reset, email verification and email link sign-in viaauth.generatePasswordResetLink(),auth.generateEmailVerificationLink()andauth.generateSignInWithEmailLink().Referdocumentation for moredetails and code samples.

Cloud Firestore

  • Upgraded Cloud Firestore client to v0.19.0.
  • Exposed theTransaction type from theadmin.firestore namespace.

Cloud Messaging

  • Improved error handling in FCM. The SDK now checks the keytype.googleapis.com/google.firebase.fcm.v1.FcmError to set error code.Thankschemidy for thecontribution.

Version 6.1.0 - October 22, 2018

  • Upgraded the Cloud Firestore client from 0.16.0 to0.18.0.

Version 6.0.0 - August 9, 2018

  • The Admin SDK no longer supports Node.js 4. Developers must useNode.js 6 or higher to deploy the Admin SDK.
  • The Admin SDK now installs Cloud Firestore and Cloud Storagelibraries as optional dependencies. SDK installation no longer fails whenencountering errors from Cloud Firestore, Cloud Storage or gRPC dependencies.
  • Upgraded the Cloud Firestore client from 0.15.4 to0.16.0.This version contains a newarray-contains query operator andFieldValue.arrayUnion() andFieldValue.arrayRemove() APIs.

Version 5.13.1 - July 23, 2018

  • Upgraded the Cloud Firestore client from 0.15.2 to0.15.4.This version contains a bug fix that enables using it in environmentswhere application default credentials are not available.

Version 5.13.0 - July 17, 2018

  • The Admin SDK can now read the Firebase/Google Cloud Platformproject ID from bothGCLOUD_PROJECT andGOOGLE_CLOUD_PROJECT environmentvariables.
  • Upgraded the Cloud Firestore client from 0.14.0 to0.15.2.This version of the Firestore client changes how date values are handled.

Authentication

  • The Admin SDK can now create custom tokens without beinginitialized with service account credentials.
  • The SDK accepts a newserviceAccountIdapp option, which can be used to specify just the client email of a serviceaccount.
  • When deployed in an environment managed by Google (e.g. GoogleCloud Functions), the SDK can auto discover a service account ID withoutany explicit configuration.

Realtime Database

  • Updated typings of theadmin.database.Query.once() method toreturn a more specific type.

Cloud Messaging

  • Updated typings of theadmin.messaging.WebpushNotification typeto include all supported notification fields.

Version 5.12.1 - May 15, 2018

  • Admin SDK now lazy loads all child namespaces and certain heavydependencies for faster load times. This change also ensures that onlythe sources for namespaces that are actually used get loaded into theNode.js process.
  • Upgraded the Cloud Firestore client from 0.13.0 to 0.14.0.

Version 5.12.0 - April 05, 2018

Authentication

Cloud Messaging

  • Added themutableContent optional field to themessaging.Apstype. This can be used to set themutable-content property when sendingFCM messages to APNS targets.
  • Added support for specifying arbitrary key-value fields in themessaging.Aps type.

Version 5.11.0 - March 15, 2018

Authentication

Version 5.10.0 - March 08, 2018

  • Upgraded theRealtime Database client from 0.1.11 to 0.2.0. Thisprovides the ability to calladmin.database().ref()with an existing reference as the argument.
  • Upgraded the Cloud Firestore client from 0.12.0 to0.13.0.

Version 5.9.1 - February 28, 2018

  • Theadmin.initializeApp() method can now be invoked without acredential option. The SDK uses Google Application Default Credentialswhen initialized this way.
  • Upgraded the Cloud Firestore client from 0.11.1 to0.12.0.
  • Upgraded the Cloud Storage client from 1.2.1 to 1.6.0.
  • Upgraded theRealtime Database client from 0.1.3 to 0.1.11.

Version 5.9.0 - February 14, 2018

Cloud Messaging

Version 5.8.2 - January 30, 2018

  • Exposedadmin.firestore.DocumentReference andadmin.firestore.DocumentSnapshot types from the Admin SDK typings.
  • Upgraded Firestore dependency version to 0.11.2. This includesseveral bug fixes including a fix in theDocumentReference.update()operation.

Version 5.8.1 - January 17, 2018

  • Upgraded Firestore dependency version from 0.10.0 to 0.11.1.This includes several bug fixes in Cloud Firestore.

Version 5.8.0 - January 11, 2018

Initialization

  • Theadmin.initializeApp()method can now be invoked without any arguments. This initializes an appusing Google Application Default Credentials, and otherAppOptions loaded fromtheFIREBASE_CONFIG environment variable.

Authentication

  • Upgraded thejsonwebtoken library to 8.1.0.

Version 5.7.0 - January 04, 2018

Authentication

  • A newrevokeRefreshTokens()method for revoking refresh tokens issued to a user.
  • TheverifyIdToken()method now accepts an optionalcheckRevoked argument, which can be used tocheck if a given ID token has been revoked.

Version 5.6.0 - December 21, 2017

  • A newadmin.instanceId()API that facilitates deleting instance IDs and associated user data fromFirebase projects.
  • Updated the TypeScript typings foradmin.AppOptions to reflect theintroduction of theprojectId option.
  • Removed some unused third party dependencies.

Version 5.5.1 - November 21, 2017

Cloud Firestore

  • Upgraded the Cloud Firestore client to the latest availableversion, which adds input validation to several operations, and retry logicto handle network errors.

Realtime Database

  • Fixed an issue in the TypeScript typings of theRealtime Database API.

Version 5.5.0 - November 10, 2017

Realtime Database

  • app.database()method now optionally accepts a database URL. This feature can be used toaccess multiple Realtime Database instances from the same app.
  • Upgraded the Realtime Database client to the latest availableversion.

Cloud Firestore

  • Upgraded the Cloud Firestore client to the latest availableversion.

Version 5.4.3 - October 24, 2017

  • Fixed a regression in module loading that prevented usingthe Admin SDK in environments like AWS Lambda. This regression wasintroduced in the 5.4.0 release, which added a new dependency to Firestoreand gRPC. This fix lazily loads Firestore and gRPC, thus enablingAdmin SDK usage in the affected environments as long as no explicitattempts are made to use the Firestore API.

Version 5.4.2 - October 09, 2017

  • Upgraded the Cloud Firestore client dependency to 0.8.2, whichresolves an issue with saving objects with nested document references.

Version 5.4.1 - October 03, 2017

  • Upgraded the Firestore client dependency to 0.8.1, which resolvesthe installation issues reported in the Yarn environment.

Version 5.4.0 - October 03, 2017

Version 5.3.0 - September 27, 2017

  • SDK now retries outbound HTTP calls on all low-level I/O errors.

Authentication

Cloud Storage

  • Declared a more concrete TypeScript return type (Bucket) for thebucket() methodin theCloud Storage API.

Version 5.2.1 - August 16, 2017

  • A bug in the TypeScript type declarations that come bundled with theSDK (index.d.ts) has been fixed.

Version 5.2.0 - August 14, 2017

Authentication

  • New type definitions for the arguments ofcreateUser() andupdateUser() methods.

Cloud Messaging

  • Redefined the arguments ofsendToDevice() using intersectioninstead of overloading.

Version 5.1.0 - July 25, 2017

Authentication

  • Added the methodgetUserByPhoneNumber()to theadmin.auth interface. This methodenables retrieving user profile information by a phone number.
  • createUser()andupdateUser() methodsnow accept aphoneNumber property, which can be used to create users with a phonenumber field and/or update the phone number associated with a user.
  • Added thephoneNumber field toadmin.auth.UserRecord,which exposes the phone number associated with a user account.
  • Added thephoneNumber field toadmin.auth.UserInfo,which exposes the phone number associated with a user account by a linkedidentity provider.

Version 5.0.1 - July 12, 2017

  • Improved the error messages thrown in the case of network and RPCerrors. These errors now include outgoing HTTP request details that makeit easier to localize and debug issues.

Authentication

  • Implemented support in the user management API for handling photoURLs with special characters.

Version 5.0.0 - May 17, 2017

Initialization

  • The deprecatedserviceAccount property in theadmin.App.Optionstype has been removed in favor of thecredential property.
  • Initializing the SDK without setting a credentialresults in an exception.
  • Initializing the SDK with a malformed private key stringresults in an exception.

Authentication

  • createdAt andlastSignedInAt properties inadmin.auth.UserMetadatahave been renamed tocreationTime andlastSignInTime. Also theseproperties now provide UTC formatted strings instead ofDate values.

Version 4.2.1 - April 12, 2017

  • Updated the SDK to periodically refresh the OAuth access tokeninternally used byFirebaseApp. This reduces the number of authenticationfailures encountered at runtime by SDK components likeRealtime Database.

Version 4.2.0 - April 04, 2017

Cloud Messaging

Version 4.1.4 - March 28, 2017

Authentication

  • Cleaned up a number of types to improve the log output, therebymaking debugging easier.

Realtime Database

  • Fixed an issue which could cause infinite loops when usingpush()with no arguments.

Version 4.1.3 - March 7, 2017

  • Fixed incorrect usage ofundefined - as opposed tovoid - inseveral places in the TypeScript typings.
  • Added missing properties to the TypeScript typings forDecodedIdToken.
  • Fixed issues when using some types with the TypeScriptstrictNullChecks option enabled.
  • Removed incorrectadmin.Promise type from the TypeScript typingsin favor of the Node.js built-inPromise type, which the SDK actually uses.
  • Added error codes to all app-level errors. All errors in the SDKnow properly implement theFirebaseError interface.
  • Improved error handling when initializing the SDK with a credentialthat cannot generate valid access tokens.
  • Added newadmin.database.EventType to the TypeScript typings.

Realtime Database

  • Improved how theRealtime Database reports errors when provided withvarious types of invalid credentials.

Version 4.1.2 - March 2, 2017

Authentication

  • Improved input validation and error messages for all usermanagement methods.
  • verifyIdToken()now works with non-cert credentials, assuming theGCLOUD_PROJECT environmentvariable is set to your project ID, which is the case when running on Googleinfrastructure such as Google App Engine and Google Compute Engine.

Realtime Database

  • AddedtoJSON() methods to theDataSnapshot andQuery objectsto make them properly JSON-serializable.

Cloud Messaging

Version 4.1.1 - February 14, 2017

  • Added in missing TypeScript typings for theFirebaseError.toJSON()method.

Authentication

  • Fixed issue withcreateUser()which sometimes caused multiple users to share the same email.

Version 4.1.0 - February 2, 2017

  • Added in missing TypeScript typings for thetoJSON() method offof several objects.

Cloud Messaging

Version 4.0.6 - January 24, 2017

Initialization

  • Fixed an issue which caused importing the library via the ES2015import syntax (import * as admin from "firebase-admin") to not workproperly.

Version 4.0.5 - January 17, 2017

  • TypeScript support has been greatly improved. Typings for theRealtime Database are now available and all other known issues with incorrect orincomplete type information have been resolved.

Initialization

  • Fixed an issue which caused the SDK to appear to hang when providedwith a credential that generated invalid access tokens. The most common causeof this was using a credential whose access had been revoked. Now, an errorwill be logged to the console in this scenario.

Authentication

  • The error message for anauth/internal-error error now includesthe raw server response to more easily debug and track down unhandled errors.
  • Fixed an issue that caused anauth/internal-error error to bethrown when callinggetUser() orgetUserByEmail()for a user without a creation date.
  • Fixed an issue which caused anauth/internal-error error to bethrown when callingcreateUser() withan email that corresponds to an existing user.
  • Fixed an issue which caused anauth/internal-error error to bethrown when callingAuthentication methods with a credential with insufficientpermission. Now, anauth/insufficient-permission error will be throwninstead.

Version 4.0.4 - December 6, 2016

Authentication

  • Fixed an issue that caused severalAuthentication methods to throwan error when provided with inputs containing Unicode characters.

Version 4.0.3 - November 21, 2016

Initialization

  • Fixed an issue that caused anull value for thedatabaseAuthVariableOverride property to be ignored when passed as partof the first argument toinitializeApp(), whichcaused the app to still have full admin access. Now, passing this value hasthe expected behavior: the app has unauthenticated access to theRealtime Database, and behaves as if no user is logged into the app.

Authentication

  • Fixed an issue that caused anauth/invalid-uid error tobe thrown for validuid values passed to severalAuthentication methods.

Version 4.0.2 - November 15, 2016

  • Improved error messages throughout the Admin Node.js SDK.
  • Upgraded dependencies so that the Admin Node.js SDK no longerthrows warnings for using deprecatedBuffer APIs in Node.js7.x.x.

Version 4.0.1 - November 9, 2016

  • Fixed issue which caused the4.0.0 release to notinclude theREADME.md andnpm-shrinkwrap.json files.

Version 4.0.0 - November 7, 2016

  • The Admin Node.js SDK (available on npm asfirebase-admin) is anew SDK which replaces and expands the admin capabilities of the standardfirebase npm module. SeeAdd the Firebase Admin SDK to your Server to getstarted.
  • This version does not include theREADME.md andnpm-shrinkwrap.json files. This was fixed in version4.0.1.

Initialization

Authentication

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-25 UTC.