Firebase Admin Node.js SDK

The SDK currently supports Node.js 22 and higher.

Security Warning: The Admin SDK should only be used in server-side or back-end environments controlled by the app developer (e.g., servers, serverless platforms, or cloud environments). Do not use the Admin SDK in client-side environments.

When you need to evaluate Remote Config parameters on a server based on specific user context, use ServerTemplate.

1. Use initServerTemplate(options) to create a template instance.
2. Use load() to fetch the template data.
3. Use evaluate(context) to get a ServerConfig object tailored to the provided EvaluationContext (which includes UserProvidedSignals and PredefinedSignals).
4. Access values via ServerConfig methods like getString(key), getNumber(key), or getBoolean(key).

const serverTemplate = remoteConfig.initServerTemplate();
await serverTemplate.load();

const context = { myCustomSignal: 'value' }; // UserProvidedSignals
const config = serverTemplate.evaluate(context);
const myValue = config.getString('my_parameter_key');

When enqueuing a task, you can control when it runs using the DeliverySchedule type. You must choose between one of two mutually exclusive modes:

1. DelayDelivery: Uses scheduleDelaySeconds (a number) to specify how many seconds to wait before execution.
2. AbsoluteDelivery: Uses scheduleTime (a Date) to specify a specific point in time for execution.

Note: You cannot provide both scheduleDelaySeconds and scheduleTime in the same options object.

When executing operations, you can use the impersonate option within GraphqlOptions or OperationOptions to simulate different authentication states. This is useful for testing security rules or performing actions on behalf of a user.

• ImpersonateAuthenticated: Provide authClaims (a partial DecodedIdToken) to simulate a logged-in user.
• ImpersonateUnauthenticated: Set unauthenticated: true to simulate an unauthenticated request.

If your project uses ES2015 modules, import initializeApp from firebase-admin/app.

import { initializeApp } from "firebase-admin/app";

initializeApp();

To use the SDK, you must initialize the app. You can use CommonJS require or ES2015 import syntax depending on your environment.

const { initializeApp } = require("firebase-admin/app");

initializeApp();

Install the SDK via npm using the firebase-admin package.

$ npm install --save firebase-admin

The SecurityRules service allows you to programmatically manage security rules for Cloud Firestore and Cloud Storage. You can create new rulesets from source code, apply (release) them to your services, retrieve existing rulesets, and list metadata for all rulesets in your project.

To use this service, access it via admin.securityRules() after initializing your Firebase Admin app.

When using HttpClient.send(), the result is a Promise<RequestResponse>.

• Successful responses (2xx): Resolve with a RequestResponse object. You can access status, headers, text, and data (if the response is JSON). Use isJson() to check if the data field is available.
• Server errors (3xx, 4xx, 5xx): Reject with a RequestResponseError. This error contains the response object, allowing you to inspect the status and headers returned by the server.
• Network/Internal errors: Reject with a FirebaseAppError (e.g., NETWORK_TIMEOUT or NETWORK_ERROR).

When creating or updating users, you can manage their enrolled second factors using the multiFactor property in CreateRequest or UpdateRequest objects.

Creating a user with MFA

Use MultiFactorCreateSettings to specify a list of CreateMultiFactorInfoRequest objects. Currently, only phone is supported.

Updating a user's MFA

Use MultiFactorUpdateSettings to manage enrolled factors.

• Providing a list of UpdateMultiFactorInfoRequest objects will overwrite the user's existing list.
• Passing null to enrolledFactors will remove all existing second factors for that user.

Percent conditions allow you to target a specific portion of your user base. You must specify a percentOperator and the corresponding limit or range.

Operators:

• LESS_OR_EQUAL: Targets percentiles less than or equal to microPercent.
• GREATER_THAN: Targets percentiles greater than microPercent.
• BETWEEN: Targets percentiles within the microPercentRange (lower bound is exclusive, upper bound is inclusive).

Important Notes:

• microPercent values must be in the range [0 and 100000000].
• seed: A case-sensitive string (0-32 ASCII characters) used to ensure consistent hashing for the user group.