Registry / gcp / google-auth-library

google-auth-library

library10.6.2jsnpmunverified

This is Google's officially supported client library for Node.js, providing comprehensive functionality for OAuth 2.0 authorization and authentication with Google APIs. It abstracts away the complexities of credential management, offering various authentication flows including Application Default Credentials (ADC), OAuth2 for user consent, JSON Web Tokens (JWT) for service-to-service communication, and direct access for Google Compute environments. The library is currently at version 10.6.2 and undergoes continuous development, with regular bug fixes and feature enhancements released typically on a monthly basis, as evidenced by recent changelog entries from March and February 2026. Key differentiators include its robust support for workload and workforce identity federation, impersonated credentials, and downscoped clients, making it suitable for a wide array of use cases from local development to complex multi-cloud deployments. It ships with TypeScript types, ensuring a typed developer experience.

gcp auth-security type-stubs

npm install google-auth-library

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GOOGLE-AUTH-LIBRAR

google-auth-library

gcpjavascriptv10.6.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

GoogleAuth

✓ import { GoogleAuth } from 'google-auth-library';

✗ const GoogleAuth = require('google-auth-library').GoogleAuth;

The primary entry point for Application Default Credentials (ADC) and general credential management. The library is primarily ESM-first, so 'require' can lead to issues in mixed environments.

OAuth2Client

✓ import { OAuth2Client } from 'google-auth-library';

✗ import OAuth2Client from 'google-auth-library';

Used for user-based OAuth 2.0 flows. This is a named export, not a default export.

JWT

✓ import { JWT } from 'google-auth-library';

✗ const JWT = require('google-auth-library').JWT;

For authentication using JSON Web Tokens (JWTs), typically with service accounts. Like other main exports, it's a named export in an ESM-preferred package.

Installs the library and authenticates using Application Default Credentials (ADC) to obtain and verify an access token.

import { GoogleAuth } from 'google-auth-library'; async function authenticateWithADC() { const auth = new GoogleAuth({ scopes: 'https://www.googleapis.com/auth/cloud-platform', }); // Get the credentials for the default project const client = await auth.getClient(); const accessToken = await client.getAccessToken(); console.log('Successfully obtained access token using Application Default Credentials.'); console.log('Access Token:', accessToken.token); // Example: Use the token to make an authenticated request // (This is illustrative; actual API calls would use a client library or fetch with Authorization header) if (accessToken.token) { const url = 'https://www.googleapis.com/oauth2/v1/tokeninfo?access_token=' + accessToken.token; try { const response = await fetch(url); const data = await response.json(); console.log('Token Info:', data); } catch (fetchError) { console.error('Failed to verify token:', fetchError); } } else { console.warn("No access token found. Ensure ADC is configured correctly (e.g., GOOGLE_APPLICATION_CREDENTIALS set or running on GCP)."); } } authenticateWithADC().catch(console.error);

Debug

Known issues

breakingThe library explicitly requires Node.js v18 or newer. Running on older versions will result in runtime errors or unexpected behavior.

fix

Upgrade your Node.js environment to version 18 or a more recent LTS release (e.g., using nvm: `nvm install 18 && nvm use 18`).

affects: >=10.0.0

gotchaWhile the library supports CommonJS, it is primarily designed for ES Modules. Using incorrect import syntax (e.g., `require` in an ES Module context) can lead to 'require is not defined' or `undefined` module exports.

fix

For new projects or modern Node.js environments, use ES Module `import` syntax (e.g., `import { Class } from 'pkg';`). Ensure your `package.json` specifies `"type": "module"` for ESM projects.

affects: >=10.0.0

breakingThe `gtoken` dependency, previously exposed in some internal contexts, was internalized within the `google-auth-library` since v10.6.0. Direct access or manipulation of `gtoken` objects is no longer officially supported and may break.

fix

Rely solely on the public API of `google-auth-library` for token management and generation. Avoid direct interaction with internal `gtoken` implementations.

affects: >=10.6.0

gotchaApplication Default Credentials (ADC) require proper environment configuration (e.g., `GOOGLE_APPLICATION_CREDENTIALS` environment variable, `gcloud` login, or running on GCP/GKE) to function automatically. Without it, authentication calls will fail.

fix

Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to the path of your service account key file, run `gcloud auth application-default login`, or ensure your application is deployed on a Google Cloud environment that provides default credentials.

affects: >=1.0.0

gotchaUpdates to underlying HTTP proxy agents (e.g., `http-proxy-agent` updated to v7 in `teeny-request`, which is used by this library) may require adjustments if custom proxy configurations are used, potentially causing connection issues.

fix

Review and update custom proxy agent configurations to be compatible with the latest `http-proxy-agent` versions. Ensure any custom agent factories are correctly exporting constructors or objects as expected by updated dependencies.

affects: >=10.6.2

Errors

Common errors & fixes

Error: Node.js v16.x.x is not supported.

The installed version of `google-auth-library` requires Node.js v18 or newer.

fix

Upgrade your Node.js runtime to version 18 or higher. For example, using nvm: `nvm install 18 && nvm use 18`.

TypeError: require is not a function

Attempting to use CommonJS `require()` syntax within an ES Module (ESM) context, or a general module import mismatch.

fix

If your project is ESM, ensure `"type": "module"` is set in `package.json` and use `import` statements. If CommonJS, verify no conflicting ESM configurations.

Error: Could not load the default credentials. Browse to https://cloud.google.com/docs/authentication/getting-started for more information.

Application Default Credentials (ADC) could not be automatically located or configured in the current environment.

fix

Authenticate using `gcloud auth application-default login`, set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to a service account key file path, or ensure your application runs within a Google Cloud environment with associated service accounts.

Upgrade

Version history

10.6.2latest on npm

Audit

Dependencies

gaxiosrequiredUsed internally for making HTTP requests, frequently updated in sync with the auth library.

Agent activity

38 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/googleapis/google-cloud-node-core ↗

packagehttps://www.npmjs.com/package/google-auth-library ↗

homepagehttps://googleapis.dev/nodejs/google-auth-library/latest ↗