firebase-admin.app package

Firebase 앱 및 SDK 초기화

Functions

함수 설명
applicationDefault(httpAgent)에 의해 지정됩니다. Firebase 서비스에 대한 관리자 액세스 권한을 부여하는 Google 애플리케이션 기본 사용자 인증 정보에서 생성된 사용자 인증 정보를 반환합니다. 이 사용자 인증 정보는 initializeApp() 호출에서 사용할 수 있습니다.Google 애플리케이션 기본 사용자 인증 정보는 Google App Engine 및 Google Compute Engine과 같은 모든 Google 인프라에서 사용할 수 있습니다.자세한 내용은 SDK 초기화를 참고하세요.
cert(serviceAccountPathOrObject, httpAgent) Firebase 서비스에 대한 관리 액세스 권한을 부여하는, 제공된 서비스 계정에서 생성된 사용자 인증 정보를 반환합니다. 이 사용자 인증 정보는 initializeApp() 호출에서 사용할 수 있습니다.자세한 내용은 SDK 초기화를 참고하세요.
deleteApp(앱) 지정된 App를 사용할 수 없게 하고 연결된 모든 서비스의 리소스를 해제합니다 (백엔드 리소스는 정리하지 *않음*). SDK를 로컬에서 실행하는 경우 프로세스를 정상적으로 종료하려면 이 메서드를 호출해야 합니다.
getApp(앱 이름)
getApps()를 참고하세요.
initializeApp(options, appName)을
refreshToken(refreshTokenPathOrObject, httpAgent) Firebase 서비스에 대한 관리자 액세스 권한을 부여하는 제공된 갱신 토큰에서 생성된 사용자 인증 정보를 반환합니다. 이 사용자 인증 정보는 initializeApp() 호출에서 사용할 수 있습니다.자세한 내용은 SDK 초기화를 참고하세요.

인터페이스

인터페이스 설명
앱 Firebase 앱은 서비스 모음에 대한 초기화 정보를 보관합니다.
AppOptions initializeApp()에 전달할 수 있는 옵션
사용자 인증 정보 Firebase 서비스 인증에 사용되는 Google OAuth2 액세스 토큰을 제공하는 인터페이스입니다.대부분의 경우 직접 구현할 필요가 없으며 대신 firebase-admin/app 모듈에서 제공하는 기본 구현을 사용할 수 있습니다.
FirebaseArrayIndexError FirebaseError 객체와 오류가 발생한 항목을 가져오는 데 사용할 수 있는 색인을 모두 포함하는 복합 유형입니다.
FirebaseError FirebaseError는 표준 자바스크립트 Error 객체의 서브클래스입니다. 여기에는 메시지 문자열과 스택 트레이스 외에도 문자열 코드가 포함됩니다.
GoogleOAuthAccessToken Google OAuth 2.0 액세스 토큰용 인터페이스입니다.
서비스 계정

변수

변수 설명
SDK_VERSION

applicationDefault(httpAgent)

Firebase 서비스에 대한 관리자 액세스 권한을 부여하는 Google 애플리케이션 기본 사용자 인증 정보에서 생성된 사용자 인증 정보를 반환합니다. 이 사용자 인증 정보는 initializeApp() 호출에서 사용할 수 있습니다.

Google 애플리케이션 기본 사용자 인증 정보는 Google App Engine 및 Google Compute Engine과 같은 모든 Google 인프라에서 사용할 수 있습니다.

자세한 내용은 SDK 초기화를 참고하세요.

서명:

export declare function applicationDefault(httpAgent?: Agent): Credential;

매개변수

매개변수 유형 설명
http에이전트 에이전트 Google 토큰 서버에서 액세스 토큰을 가져올 때 사용할 선택적 HTTP 에이전트입니다.

반환:

사용자 인증 정보

Google 애플리케이션 기본 사용자 인증 정보를 통해 인증된 사용자 인증 정보로, 앱을 초기화하는 데 사용할 수 있습니다.

예

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject, httpAgent)

Firebase 서비스에 대한 관리 액세스 권한을 부여하는, 제공된 서비스 계정에서 생성된 사용자 인증 정보를 반환합니다. 이 사용자 인증 정보는 initializeApp() 호출에서 사용할 수 있습니다.

자세한 내용은 SDK 초기화를 참고하세요.

서명:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

매개변수

매개변수 유형 설명
serviceAccountPathOrObject 문자열 | ServiceAccount 서비스 계정 키 JSON 파일 또는 서비스 계정 키를 나타내는 객체의 경로입니다.
http에이전트 에이전트 Google 토큰 서버에서 액세스 토큰을 가져올 때 사용할 선택적 HTTP 에이전트입니다.

반환:

사용자 인증 정보

제공된 서비스 계정을 통해 인증된 사용자 인증 정보로, 앱을 초기화하는 데 사용할 수 있습니다.

예 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

예 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

deleteApp(앱)

지정된 App를 사용할 수 없게 하고 연결된 모든 서비스의 리소스를 해제합니다 (백엔드 리소스는 정리하지 *않음*). SDK를 로컬에서 실행하는 경우 프로세스를 정상적으로 종료하려면 이 메서드를 호출해야 합니다.

서명:

export declare function deleteApp(app: App): Promise<void>;

매개변수

매개변수 유형 설명
앱 앱

반환:

프로미스<void>

예

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(appName)

서명:

export declare function getApp(appName?: string): App;

매개변수

매개변수 유형 설명
앱 이름 문자열

반환:

앱

getApps()

서명:

export declare function getApps(): App[];

반환:

앱[]

initializeApp(옵션, appName)

서명:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

매개변수

매개변수 유형 설명
옵션 AppOptions
앱 이름 문자열

반환:

앱

refreshToken(refreshTokenPathOrObject, httpAgent)

Firebase 서비스에 대한 관리자 액세스 권한을 부여하는 제공된 갱신 토큰에서 생성된 사용자 인증 정보를 반환합니다. 이 사용자 인증 정보는 initializeApp() 호출에서 사용할 수 있습니다.

자세한 내용은 SDK 초기화를 참고하세요.

서명:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

매개변수

매개변수 유형 설명
새로고침 토큰 경로 OrObject 문자열 | 객체 Google OAuth2 갱신 토큰 JSON 파일 또는 Google OAuth2 갱신 토큰을 나타내는 개체의 경로입니다.
http에이전트 에이전트 Google 토큰 서버에서 액세스 토큰을 가져올 때 사용할 선택적 HTTP 에이전트입니다.

반환:

사용자 인증 정보

제공된 서비스 계정을 통해 인증된 사용자 인증 정보로, 앱을 초기화하는 데 사용할 수 있습니다.

예

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK 버전

서명:

SDK_VERSION: string