firebase-admin.app-check package

Firebase App Check.

Functions

Function Description
getAppCheck(app) Gets the AppCheck service for the default app or a given app.getAppCheck() can be called with no arguments to access the default app's AppCheck service or as getAppCheck(app) to access the AppCheck service associated with a specific app.

Classes

Class Description
AppCheck The Firebase AppCheck service interface.

Interfaces

Interface Description
AppCheckToken Interface representing an App Check token.
AppCheckTokenOptions Interface representing App Check token options.
DecodedAppCheckToken Interface representing a decoded Firebase App Check token, returned from the AppCheck.verifyToken() method.
VerifyAppCheckTokenOptions Interface representing options for the AppCheck.verifyToken() method.
VerifyAppCheckTokenResponse Interface representing a verified App Check token response.

getAppCheck(app)

Gets the AppCheck service for the default app or a given app.

getAppCheck() can be called with no arguments to access the default app's AppCheck service or as getAppCheck(app) to access the AppCheck service associated with a specific app.

Signature:

export declare function getAppCheck(app?: App): AppCheck;

Parameters

Parameter Type Description
app App Optional app for which to return the AppCheck service. If not provided, the default AppCheck service is returned.

Returns:

AppCheck

The default AppCheck service if no app is provided, or the AppCheck service associated with the provided app.

Example 1

// Get the `AppCheck` service for the default app
const defaultAppCheck = getAppCheck();

Example 2

// Get the `AppCheck` service for a given app
const otherAppCheck = getAppCheck(otherApp);