Interface FirebaseContext

The type of data that will be added to an Action's context when using the fireabse middleware. You can safely cast Action's context to a Firebase Context to help type checking and code complete.

interface FirebaseContext {
    app?: {
        alreadyConsumed?: boolean;
        appId: string;
        rawToken: string;
        token: DecodedAppCheckToken;
    };
    auth?: { rawToken: string; token: DecodedIdToken; uid: string };
    firebaseApp?: FirebaseServerApp;
    instanceIdToken?: string;
}

Properties

app? auth? firebaseApp? instanceIdToken?

Properties

Optionalapp

app?: {
    alreadyConsumed?: boolean;
    appId: string;
    rawToken: string;
    token: DecodedAppCheckToken;
}

Information about the AppCheck token for a request. This comes form the X-Firebase-AppCheck header and is included in the firebase-functions client libraries (which can be used for Genkit requests irrespective of whether they're hosted on Firebase). Will be omitted if AppCheck tokens are invalid. To reject requests in these cases, set enforceAppCheck in a declaritve policy or check in a policy callback.

Optionalauth

auth?: { rawToken: string; token: DecodedIdToken; uid: string }

Information about the authorized user. This comes from the Authentication header, which is a JWT bearer token. Will be omitted if auth is not defined or the key is invalid. To reject requests in these cases set signedIn in a declarative policy or check in a policy callback.

OptionalfirebaseApp

firebaseApp?: FirebaseServerApp

A FirebaseServerApp with the same Auth and App Check credentials as the request.

OptionalinstanceIdToken

instanceIdToken?: string

An unverified token for a Firebase Instance ID.

Settings

Member Visibility

On This Page

Properties