Options
All
  • Public
  • Public/Protected
  • All
Menu

Module credential

Index

Interfaces

Functions

Functions

applicationDefault

  • applicationDefault(httpAgent?: Agent): Credential

  • Returns a credential created from the Google Application Default Credentials that grants admin access to Firebase services. This credential can be used in the call to admin.initializeApp().

    Google Application Default Credentials are available on any Google infrastructure, such as Google App Engine and Google Compute Engine.

    See Initialize the SDK for more details.

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

    Parameters

    • Optional httpAgent: Agent

      Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

    Returns Credential

    A credential authenticated via Google Application Default Credentials that can be used to initialize an app.

cert

  • Returns a credential created from the provided service account that grants admin access to Firebase services. This credential can be used in the call to admin.initializeApp().

    See Initialize the SDK for more details.

    example
    // 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"
});
    example
    // 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"
});

    Parameters

    • serviceAccountPathOrObject: string | ServiceAccount

      The path to a service account key JSON file or an object representing a service account key.

    • Optional httpAgent: Agent

      Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

    Returns Credential

    A credential authenticated via the provided service account that can be used to initialize an app.

refreshToken

  • refreshToken(refreshTokenPathOrObject: string | Object, httpAgent?: Agent): Credential

  • Returns a credential created from the provided refresh token that grants admin access to Firebase services. This credential can be used in the call to admin.initializeApp().

    See Initialize the SDK for more details.

    example
    // 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"
});

    Parameters

    • refreshTokenPathOrObject: string | Object

      The path to a Google OAuth2 refresh token JSON file or an object representing a Google OAuth2 refresh token.

    • Optional httpAgent: Agent

      Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

    Returns Credential

    A credential authenticated via the provided service account that can be used to initialize an app.

Generated using TypeDoc