mirror of https://github.com/hanzoai/openid-client.git synced 2026-09-24 17:01:10 +00:00

Files

T

Filip Skokan 53927452eb refactor!: openid-client@6

BREAKING CHANGE: openid-client v6.x is a complete rewrite of the openid-client module, this is the first time since 0.1.0 (8 years ago) that the API has drastically changed. The new module structure and API focuses on three core principles:

- runtime compatibility (adding support for Deno, Cloudflare Workers, Bun, and other Web API interoperable runtimes)
- tree-shakeability (bundles should not contain features that don't end up being used)
- less options (removing support for processing deprecated response types, cutting down on the number of combinations that need to handled)

To that end openid-client@6 no longer supports the full cartesian matrix of response types and response modes, it no longer supports issuing encrypted assertions, decrypting assertions is limited to only a few algorithms, it no longer supports Dynamic Client Registration or Management, and Self-Issued OpenID Provider responses are also not supported.

The new API makes basic setups simple while allowing some degree of complexity where needed.

openid-client@6 is an ESM module using ES2022 syntax and it depends on WebCryptoAPI and Fetch API globals being available in the JS runtime.

openid-client@6 is written in TypeScript and its exported types come with comment annotations.

(Node.js) Versions 20.x and newer have all the necessary globals.

(Node.js) CJS style `let client = require('openid-client')` is possible in versions where `process.features.require_module` is `true`. This is a new Node.js feature slated to be released without a CLI flag in 23.x and 22.x

2024-10-15 23:58:32 +02:00

2.5 KiB

Raw Blame History

Class: Configuration

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Configuration is an abstraction over the OAuth 2.0 Authorization Server metadata and OAuth 2.0 Client metadata

Configuration instances are obtained either through

(RECOMMENDED) the discovery function that discovers the OAuth 2.0 Authorization Server metadata using the Authorization Server's Issuer Identifier, or
The Configuration constructor if the OAuth 2.0 Authorization Server metadata is known upfront

Examples

(RECOMMENDED) Setting up a Configuration with a Server Metadata discovery step

let server!: URL
let clientId!: string
let clientSecret!: string | undefined

let config = await client.discovery(server, clientId, clientSecret)

Setting up a Configuration with a constructor

let server!: client.ServerMetadata
let clientId!: string
let clientSecret!: string | undefined

let config = new client.Configuration(server, clientId, clientSecret)

Implements

Constructors

new Configuration()

▸ new Configuration(server, clientId, metadata?, clientAuthentication?): Configuration

Parameters

Parameter	Type	Description
`server`	`ServerMetadata`	Authorization Server Metadata
`clientId`	`string`	Client Identifier at the Authorization Server
`metadata`?	`string` \| `Partial`<`ClientMetadata`>	Client Metadata, when a string is passed in it is a shorthand for passing just ClientMetadata.client_secret.
`clientAuthentication`?	`ClientAuth`	Implementation of the Client's Authentication Method at the Authorization Server.

Returns

Configuration

2.5 KiB Raw Blame History