123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120 |
- /*! firebase-admin v12.1.1 */
- /*!
- * @license
- * Copyright 2020 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- /// <reference types="node" />
- import { Agent } from 'http';
- import { Credential, GoogleOAuthAccessToken } from './credential';
- /**
- * Implementation of Credential that uses a service account.
- */
- export declare class ServiceAccountCredential implements Credential {
- private readonly httpAgent?;
- readonly implicit: boolean;
- readonly projectId: string;
- readonly privateKey: string;
- readonly clientEmail: string;
- private readonly httpClient;
- /**
- * Creates a new ServiceAccountCredential from the given parameters.
- *
- * @param serviceAccountPathOrObject - Service account json object or path to a service account json file.
- * @param httpAgent - Optional http.Agent to use when calling the remote token server.
- * @param implicit - An optinal boolean indicating whether this credential was implicitly discovered from the
- * environment, as opposed to being explicitly specified by the developer.
- *
- * @constructor
- */
- constructor(serviceAccountPathOrObject: string | object, httpAgent?: Agent | undefined, implicit?: boolean);
- getAccessToken(): Promise<GoogleOAuthAccessToken>;
- private createAuthJwt_;
- }
- /**
- * Implementation of Credential that gets access tokens from the metadata service available
- * in the Google Cloud Platform. This authenticates the process as the default service account
- * of an App Engine instance or Google Compute Engine machine.
- */
- export declare class ComputeEngineCredential implements Credential {
- private readonly httpClient;
- private readonly httpAgent?;
- private projectId?;
- private accountId?;
- constructor(httpAgent?: Agent);
- getAccessToken(): Promise<GoogleOAuthAccessToken>;
- /**
- * getIDToken returns a OIDC token from the compute metadata service
- * that can be used to make authenticated calls to audience
- * @param audience the URL the returned ID token will be used to call.
- */
- getIDToken(audience: string): Promise<string>;
- getProjectId(): Promise<string>;
- getServiceAccountEmail(): Promise<string>;
- private buildRequest;
- }
- /**
- * Implementation of Credential that gets access tokens from refresh tokens.
- */
- export declare class RefreshTokenCredential implements Credential {
- private readonly httpAgent?;
- readonly implicit: boolean;
- private readonly refreshToken;
- private readonly httpClient;
- /**
- * Creates a new RefreshTokenCredential from the given parameters.
- *
- * @param refreshTokenPathOrObject - Refresh token json object or path to a refresh token
- * (user credentials) json file.
- * @param httpAgent - Optional http.Agent to use when calling the remote token server.
- * @param implicit - An optinal boolean indicating whether this credential was implicitly
- * discovered from the environment, as opposed to being explicitly specified by the developer.
- *
- * @constructor
- */
- constructor(refreshTokenPathOrObject: string | object, httpAgent?: Agent | undefined, implicit?: boolean);
- getAccessToken(): Promise<GoogleOAuthAccessToken>;
- }
- /**
- * Implementation of Credential that uses impersonated service account.
- */
- export declare class ImpersonatedServiceAccountCredential implements Credential {
- private readonly httpAgent?;
- readonly implicit: boolean;
- private readonly impersonatedServiceAccount;
- private readonly httpClient;
- /**
- * Creates a new ImpersonatedServiceAccountCredential from the given parameters.
- *
- * @param impersonatedServiceAccountPathOrObject - Impersonated Service account json object or
- * path to a service account json file.
- * @param httpAgent - Optional http.Agent to use when calling the remote token server.
- * @param implicit - An optional boolean indicating whether this credential was implicitly
- * discovered from the environment, as opposed to being explicitly specified by the developer.
- *
- * @constructor
- */
- constructor(impersonatedServiceAccountPathOrObject: string | object, httpAgent?: Agent | undefined, implicit?: boolean);
- getAccessToken(): Promise<GoogleOAuthAccessToken>;
- }
- /**
- * Checks if the given credential was loaded via the application default credentials mechanism. This
- * includes all ComputeEngineCredential instances, and the ServiceAccountCredential and RefreshTokenCredential
- * instances that were loaded from well-known files or environment variables, rather than being explicitly
- * instantiated.
- *
- * @param credential - The credential instance to check.
- */
- export declare function isApplicationDefault(credential?: Credential): boolean;
- export declare function getApplicationDefault(httpAgent?: Agent): Credential;
|