/google-auth-library-nodejs

Google Auth Library for Node.js

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Google APIs Node.js Client

Build Status Code Coverage

This is Google's officially supported node.js client library for using OAuth 2.0 authorization and authentication with Google APIs.

Alpha

This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.

Questions/problems?

  • Ask your development related questions on Ask a question on Stackoverflow
  • If you've found an bug/issue, please file it on GitHub.

Installation

This library is distributed on npm. To add it as a dependency, run the following command:

$ npm install google-auth-library --save

License

This library is licensed under Apache 2.0. Full license text is available in COPYING.

Example Usage

var GoogleAuth = require('google-auth-library');

// Get the environment configured authorization
(new GoogleAuth).getApplicationDefault(function(err, authClient) {
  if (err === null) {
    // Inject scopes if they have not been injected by the environment
    if (authClient.createScopedRequired && authClient.createScopedRequired()) {
      var scopes = [
        'https://www.googleapis.com/auth/cloud-platform',
        'https://www.googleapis.com/auth/compute'
      ];
      authClient = authClient.createScoped(scopes);
    }

    // Fetch the access token
    var _ = require(lodash);
    var optionalUri = null;  // optionally specify the URI being authorized
    var reqHeaders = {};
    authClient.getRequestMetadata(optionalUri, function(err, headers) {
      if (err === null) {
        // Use authorization headers
        reqHeaders = _.merge(allHeaders, headers);
      }
    });
  }
});

Application Default Credentials

This library provides an implementation of application default credentials for Node.js.

The Application Default Credentials provide a simple way to get authorization credentials for use in calling Google APIs.

They are best suited for cases when the call needs to have the same identity and authorization level for the application independent of the user. This is the recommended approach to authorize calls to Cloud APIs, particularly when you're building an application that uses Google Compute Engine.

Contributing

See CONTRIBUTING.