credential namespace

簽名:

export declare namespace credential 

變數

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

類型別名

類型別名 說明
憑證 這個介面提供用於驗證 Firebase 服務的 Google OAuth2 存取權杖。在大部分情況下,您不需要自行導入這項權杖,可以改用 admin.credential 命名空間提供的預設實作方式。

credential.applicationDefault

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

任何 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 服務的管理員存取權。這組憑證可用於 initializeApp() 的呼叫。

詳情請參閱「初始化 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 服務的管理員存取權。這組憑證可用於 initializeApp() 的呼叫。

詳情請參閱「初始化 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

這個介面提供 Google OAuth2 存取權杖,用來驗證 Firebase 服務。

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

簽名:

type Credential = TCredential;