openid-client 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|---|---|---|---|---|
| @types/got | 9.6.12 | 4.77 kB | MIT | prod | |
| base64url | 3.0.1 | 2.89 kB | MIT | prod | |
| got | 9.6.0 | 24.07 kB | MIT | prod | 1 |
| jose | 1.28.2 | 52.04 kB | MIT | prod | 1 |
| lru-cache | 6.0.0 | 5.65 kB | ISC | prod | |
| make-error | 1.3.6 | 4.33 kB | ISC | prod | |
| object-hash | 2.2.0 | 17.85 kB | MIT | prod | |
| oidc-token-hash | 5.0.3 | 3.59 kB | MIT | prod | |
| p-any | 3.0.0 | 2.35 kB | MIT | prod |
The openid-client npm package provides an implementation of OpenID Relying Party (RP, Client) for the Node.js runtime. It supports various OpenID Connect/OAuth2.0 specifications such as OpenID Connect Core 1.0, OpenID Connect Discovery 1.0, RFC7009 - OAuth 2.0 Token revocation, RFC8628 - OAuth 2.0 Device Authorization Grant (Device Flow), and more. The package assists in consuming OpenID Connect Authorization Server responses and wrapping around requests to its endpoints.
Installing and using openid-client is straightforward with npm. First, install the package:
npm install openid-client
Once installed, you can require the package and use its various functionalities in your Node.js application. Here are examples for different use cases:
Discover an Issuer configuration using its published .well-known endpoints:
import { Issuer } from 'openid-client';
const googleIssuer = await Issuer.discover('https://accounts.google.com');
console.log('Discovered issuer %s %O', googleIssuer.issuer, googleIssuer.metadata);
Authorization Code Flow:
import { generators } from 'openid-client';
const client = new googleIssuer.Client({
client_id: 'your_client_id',
client_secret: 'your_secret_key',
redirect_uris: ['http://localhost:3000/cb'],
response_types: ['code'],
});
const code_verifier = generators.codeVerifier();
const code_challenge = generators.codeChallenge(code_verifier);
Multiple other examples for Authorization Code Flow, Implicit ID Token Flow, Device Authorization Grant (Device Flow) can be found in the package’s readme file.
For a comprehensive understanding of the openid-client npm package, you can review its official documentation on GitHub. The documentation covers various aspects such as Issuer, Client, Customizing, TokenSet, Strategy, generators, and errors.
