firebase-admin.app-check.api.md

API Report File for "firebase-admin.app-check"

Do not edit this file. It is a report generated by API Extractor.

import { Agent } from 'http';

// @public
export class AppCheck {
    // Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    readonly app: App;
    createToken(appId: string, options?: AppCheckTokenOptions): Promise<AppCheckToken>;
    verifyToken(appCheckToken: string, options?: VerifyAppCheckTokenOptions): Promise<VerifyAppCheckTokenResponse>;
}

// @public (undocumented)
export type AppCheckErrorCode = 'aborted' | 'invalid-argument' | 'invalid-credential' | 'internal-error' | 'permission-denied' | 'unauthenticated' | 'not-found' | 'app-check-token-expired' | 'unknown-error';

// @public
export interface AppCheckToken {
    token: string;
    ttlMillis: number;
}

// @public
export interface AppCheckTokenOptions {
    ttlMillis?: number;
}

// @public
export interface DecodedAppCheckToken {
    // (undocumented)
    [key: string]: any;
    app_id: string;
    aud: string[];
    exp: number;
    iat: number;
    iss: string;
    sub: string;
}

// Warning: (ae-forgotten-export) The symbol "PrefixedFirebaseError" needs to be exported by the entry point index.d.ts
//
// @public
export class FirebaseAppCheckError extends PrefixedFirebaseError {
    // Warning: (ae-forgotten-export) The symbol "ErrorInfo" needs to be exported by the entry point index.d.ts
    constructor(info: ErrorInfo, message?: string);
}

// @public
export function getAppCheck(app?: App): AppCheck;

// @public
export interface VerifyAppCheckTokenOptions {
    consume?: boolean;
}

// @public
export interface VerifyAppCheckTokenResponse {
    alreadyConsumed?: boolean;
    appId: string;
    token: DecodedAppCheckToken;
}