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

提供用于向 Firebase 服务进行身份验证的 Google OAuth2 访问令牌的接口。

在大多数情况下，您无需自行实现，而是可以使用 admin.credential 命名空间提供的默认实现。

签名：

type Credential = TCredential;