credential namespace

簽名:

export declare namespace credential 

變數

變數 說明
applicationDefault 傳回透過授予 Firebase 服務管理員存取權的 Google 應用程式預設憑證建立的憑證。這個憑證可用於對 InitialApp() 的呼叫。Google 應用程式預設憑證可透過任何 Google 基礎架構使用,例如 Google App Engine 和 Google Compute Engine。詳情請參閱初始化 SDK
憑證 傳回從授予 Firebase 服務管理員存取權的所提供服務帳戶中建立的憑證。這組憑證可用於對 InitialApp() 的呼叫。詳情請參閱初始化 SDK
refreshToken 傳回由提供的更新權杖建立的憑證,該權杖會授予 Firebase 服務的管理員存取權。這組憑證可用於對 InitialApp() 的呼叫。詳情請參閱初始化 SDK

型別別名

類型別名 說明
認證 提供用於透過 Firebase 服務進行驗證的 Google OAuth2 存取權杖的介面。在大多數的情況下,您不需要自行實作,可以改用 admin.credential 命名空間提供的預設實作方式。

credential.applicationDefault

傳回透過授予 Firebase 服務管理員存取權的 Google 應用程式預設憑證建立的憑證。此憑證可用於對 InitialApp() 的呼叫。

Google 應用程式預設憑證適用於所有 Google 基礎架構,例如 Google App Engine 和 Google Compute Engine。

詳情請參閱「初始化 SDK」。

簽名:

applicationDefault: typeof applicationDefaultFn

範例

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

credential.cert

傳回從授予 Firebase 服務管理員存取權的所提供服務帳戶中建立的憑證。此憑證可用於對 InitialApp() 的呼叫。

詳情請參閱「初始化 SDK」。

簽名:

cert: typeof certFn

範例 1

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

範例 2

// Providing a service account object inline
admin.initializeApp({
  credential: admin.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"
});

credential.refreshToken

傳回由提供的更新權杖建立的憑證,該權杖會授予 Firebase 服務的管理員存取權。此憑證可用於對 InitialApp() 的呼叫。

詳情請參閱「初始化 SDK」。

簽名:

refreshToken: typeof refreshTokenFn

範例

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

credential.Credential

提供用於進行 Firebase 服務驗證的 Google OAuth2 存取權杖的介面。

在大多數情況下,您並不需要自行實作,可以改用 admin.credential 命名空間提供的預設實作項目。

簽名:

type Credential = TCredential;